kinetic_sdk 5.0.9 → 5.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d4e659604a3667ec0f7a8de4fff9ac8b4ab1d091889a8d296fba9f93d7a71f
-  data.tar.gz: 073f2b2d4188b47314bb197e3bca79ae3eb3ce0658c5dc86f1bf7151a937c477
+  metadata.gz: 67e6967468589fa6bfdf4a523663d1675053a618882337a2d3b001265a525c19
+  data.tar.gz: 32ffee19ba6489077e6102beea1c96a2bccbad93fcd1c5ee38291ecebc8aec9d
 SHA512:
-  metadata.gz: f0dbd690e223267659a8d2c91c8355af63a6a33b8b65231a813ae93f00aa1b65444afbb6811a32c4a703479be14398a2fe1e27143e36b7a567caef45779b662e
-  data.tar.gz: f41fa365f441c0e9a2ffbd79f60afbdb95f6850d0c49bf65c63c11a8fc4ca0cb95f81e4ac4ab149c48a5843f9350b89c9bd33d4171150589fc742298318cacad
+  metadata.gz: 02d1a9fba8f13cb36dfe03848c6ffe81fe0c8be5b4298380ff8f18e39539dae0d9e17df66f17197b279a3f0022757e719d19c24827ad7d155f95db4b56e09239
+  data.tar.gz: 492ecbe9146c29d23e11f3a36fcb3a3cb52c712a5a902d8f7dbbb22c94cdac6890a85d7623265a7901a22999ade8d4c026a2fb8a6e2671ac2c10d9fb62e31393

data/CHANGELOG.md

@@ -1,8 +1,116 @@
 # Change Log
 
+## [5.0.14](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.14) (2021-01-15)
+
+**Implemented enhancements:**
+
+- Support for submitting attachments (datastore and form submissions)
+- Bug Fixes
+
+## [5.0.13](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.13) (2020-09-03)
+
+**Implemented enhancements:**
+
+- Added missing Form Type methods.
+- Deprecated some Form Type methods and replaced with simpler names.
+- Removed an unnecessary logging statement when adding a team attribute.
+- Removed double URL encoding when deleting a webhook from a Kapp.
+
+## [5.0.12](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.12) (2020-08-27)
+
+**Implemented enhancements:**
+
+- Implemented webapi APIs
+
+## [5.0.11](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.11) (2020-08-24)
+
+**Implemented enhancements:**
+
+- Allow spaces in filenames when exporting items. Spaces were removed in 5.0.10, but they are valid in Windows so allowing them if they exist.
+
+## [5.0.10](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.10) (2020-08-24)
+
+**Implemented enhancements:**
+
+- Changed how filenames are stored when items are exported to be compatible with Windows.
+
+## [5.0.9](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.9) (2020-06-29)
+
+**Implemented enhancements:**
+
+- Bug fixes
+
+## [5.0.8](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.8) (2020-06-11)
+
+**Implemented enhancements:**
+
+- Bug fixes
+
+## [5.0.7](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.7) (2020-05-15)
+
+**Implemented enhancements:**
+
+- Bug fixes
+
+## [5.0.6](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.6) (2020-04-24)
+
+**Implemented enhancements:**
+
+- Bug fixes
+
+## [5.0.5](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.5) (2020-04-24)
+
+**Implemented enhancements:**
+
+- Bug fixes
+
+## [5.0.4](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.4) (2020-02-12)
+
+**Implemented enhancements:**
+
+- Implemented platform components APIs
+
+## [5.0.3](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.3) (2020-01-17)
+
+**Implemented enhancements:**
+
+- Implemented task engine configuration APIs
+
+## [5.0.2](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.2) (2020-01-10)
+
+**Implemented enhancements:**
+
+- Fixed bug with jetching JWT regarding redirects
+
+## [5.0.1](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.1) (2020-01-10)
+
+**Implemented enhancements:**
+
+- Implemented Task System error API
+- Fixed typo in Discussions component
+
+## [5.0.0](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.0) (2019-12-19)
+
+### **1.x to 5.x Upgrade Warning**
+
+All platform components (Core, Task, Agent, Discussions...etc) should be running a 5.x release or greater.
+Unintended behavior is possible if running 5.x of the SDK against any platform component < 5.x.
+
+## [1.0.2](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/1.0.2) (2019-12-18)
+
+**Implemented enhancements:**
+
+- Bug fixes
+
+## [1.0.1](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/1.0.1) (2019-12-17)
+
+**Implemented enhancements:**
+
+- Bug fixes
+
 ## [1.0.0](https://github.com/kineticdata/kinetic-sdk-rb/tree/1.0.0) (2019-06-13)
 
-** 0.x to 1.x Upgrade Warning **
+### **0.x to 1.x Upgrade Warning**
 
 Export methods have been updated to reflect the folder structure
 of their respective API routes.
@@ -39,34 +147,3 @@ sdk.logger.info("foo")
 - Gateway errors (HTTP codes [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502), [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503), and [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504)) will automatically be retried, and may be controlled by the following options:
   - :gateway_retry_limit (default 5), set to -1 to disable retrying gateway errors
   - :gateway_retry_delay (default 1.0)
-
-## [5.0.0](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.0) (2019-12-19)
-
-** 1.x to 5.x Upgrade Warning **
-All platform components (Core, Task, Agent, Discussions...etc) should be running a 5.x release or greater.
-Unintended behavior is possible if running 5.x of the SDK against any platform component < 5.x.
-
-## [5.0.1](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.1) (2020-01-10)
-
-**Implemented enhancements:**
-
-- Implemented Task System error API
-- Fixed typo in Discussions component
-
-## [5.0.2](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.2) (2020-01-10)
-
-**Implemented enhancements:**
-
-- Fixed bug with jetching JWT regarding redirects
-
-## [5.0.3](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.3) (2020-01-17)
-
-**Implemented enhancements:**
-
-- Implmented task engine configuration APIs
-
-## [5.0.4](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.4) (2020-02-12)
-
-**Implemented enhancements:**
-
-- Implmented platform components APIs

data/lib/kinetic_sdk/agent/lib/bridges.rb

@@ -64,7 +64,6 @@ module KineticSdk
 
     # Add Bridge to Space
     #
-    # @param space [String] slug of the space
     # @param body [Hash] properties associated to the Bridge
     #   - +space+
     #   - +adapterClass+

data/lib/kinetic_sdk/agent/lib/filestores.rb

@@ -64,7 +64,6 @@ module KineticSdk
 
     # Add Filestore to Space
     #
-    # @param space [String] slug of the space
     # @param body [Hash] properties associated to the Filestore
     #   - +space+
     #   - +adapterClass+

data/lib/kinetic_sdk/agent/lib/handler.rb

@@ -64,7 +64,6 @@ module KineticSdk
 
     # Add Handler to Space
     #
-    # @param space [String] slug of the space
     # @param body [Hash] properties associated to the Handler
     #   - +space+
     #   - +definitionId+

data/lib/kinetic_sdk/core/lib/datastore_submissions.rb

@@ -8,15 +8,16 @@ module KineticSdk
     #   - +origin+ - Origin ID of the submission to be added
     #   - +parent+ - Parent ID of the submission to be added
     #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def add_datastore_submission(form_slug, payload={}, headers=default_headers)
-      # initialize "values" if nil
-      payload["values"] = {} if payload["values"].nil?
       # set origin hash if origin was passed as a string
       payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
       # set parent hash if parent was passed as a string
       payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_new_datastore_submission_values(form_slug, payload["values"])
       # Create the submission
       @logger.info("Adding a submission in the \"#{form_slug}\" Datastore Form.")
       post("#{@api_url}/datastore/forms/#{form_slug}/submissions", payload, headers)
@@ -30,15 +31,16 @@ module KineticSdk
     #   - +origin+ - Origin ID of the submission to be added
     #   - +parent+ - Parent ID of the submission to be added
     #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def add_datastore_submission_page(form_slug, page_name, payload={}, headers=default_headers)
-      # initialize "values" if nil
-      payload["values"] = {} if payload["values"].nil?
       # set origin hash if origin was passed as a string
       payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
       # set parent hash if parent was passed as a string
       payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_new_datastore_submission_values(form_slug, payload["values"])
       # Create the submission
       @logger.info("Adding a submission page in the \"#{form_slug}\" Datastore Form.")
       post("#{@api_url}/datastore/forms/#{form_slug}/submissions?page=#{encode(page_name)}", payload, headers)
@@ -51,22 +53,47 @@ module KineticSdk
     #   - +origin+ - Origin ID of the submission to be patched
     #   - +parent+ - Parent ID of the submission to be patched
     #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def patch_datastore_submission(form_slug, payload={}, headers=default_headers)
       # set the currentPage hash if currentPage was passed as a string
       payload["currentPage"] = { "name" => payload["currentPage"] } if payload["currentPage"].is_a? String
-      # initialize "values" if nil
-      payload["values"] = {} if payload["values"].nil?
       # set origin hash if origin was passed as a string
       payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
       # set parent hash if parent was passed as a string
       payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_new_datastore_submission_values(form_slug, payload["values"])
       # Create the submission
       @logger.info("Patching a submission in the \"#{form_slug}\" Form.")
       patch("#{@api_url}/datastore/forms/#{form_slug}/submissions", payload, headers)
     end
 
+    # Patch an existing Datastore Submission
+    #
+    # @param submission_id [String] id of the Submission
+    # @param payload [Hash] payload of the submission
+    #   - +origin+ - Origin ID of the submission to be patched
+    #   - +parent+ - Parent ID of the submission to be patched
+    #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def patch_existing_datastore_submission(submission_id, payload={}, headers=default_headers)
+      # set the currentPage hash if currentPage was passed as a string
+      payload["currentPage"] = { "name" => payload["currentPage"] } if payload["currentPage"].is_a? String
+      # set origin hash if origin was passed as a string
+      payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
+      # set parent hash if parent was passed as a string
+      payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_updated_datastore_submission_values(submission_id, payload["values"])
+      # Update the submission
+      @logger.info("Patching a submission with id \"#{submission_id}\"")
+      patch("#{@api_url}/datastore/submissions/#{submission_id}", payload, headers)
+    end
+
     # Find all Submissions for a Datastore Form.
     #
     # This method will process pages of form submissions and internally
@@ -164,5 +191,27 @@ module KineticSdk
       delete("#{@api_url}/datastore/submissions/#{encode(submission_id)}", headers)
     end
 
+    private
+
+    # Prepares new datastore submission values for attachment fields
+    #
+    # @param form_slug [String] datastore form slug
+    # @param values [Hash] hash of values being submitted
+    # @return [Hash] hash of values with attachment paths replaced with uploaded file information
+    def prepare_new_datastore_submission_values(form_slug, values)
+      file_upload_url = "#{@api_url.gsub('/api/v1','')}/datastore/forms/#{form_slug}/files"
+      prepare_submission_values(values, file_upload_url)
+    end
+
+    # Prepares updated datastore submission values for attachment fields
+    #
+    # @param submission_id [String] id of the Submission
+    # @param values [Hash] hash of values being submitted
+    # @return [Hash] hash of values with attachment paths replaced with uploaded file information
+    def prepare_updated_datastore_submission_values(submission_id, values)
+      file_upload_url = "#{@api_url.gsub('/api/v1','')}/datastore/submissions/#{submission_id}/files"
+      prepare_submission_values(values, file_upload_url)
+    end
+
   end
 end

data/lib/kinetic_sdk/core/lib/form_types.rb

@@ -2,6 +2,7 @@ module KineticSdk
   class Core
 
     # Add a form type on a Kapp
+    # The method is being depreciated and replaced with add_formtype
     #
     # @param kapp_slug [String] slug of the Kapp the form type belongs to
     # @param body [Hash] form type properties
@@ -14,7 +15,30 @@ module KineticSdk
       post("#{@api_url}/kapps/#{kapp_slug}/formTypes", body, headers)
     end
 
+    alias :add_formtype :add_form_type_on_kapp
+
+    def add_form_type_on_kapp(kapp_slug, body, headers=default_headers)
+      logger.info "Deprecation Warning: add_form_type_on_kapp method will be removed in a future version. Please use #add_formtype"
+      add_formtype(kapp_slug, body, headers=default_headers)
+    end
+    
+    
+    # Update a form type on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the form type belongs to
+    # @param name [String] name of the form type
+    # @param body [Hash] form type properties
+    #   - +name+ - A descriptive name for the form type
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def update_formtype(kapp_slug, name, body, headers=default_headers)
+      raise StandardError.new "Form Type properties is not valid, must be a Hash." unless body.is_a? Hash
+      @logger.info("Updating Form Type \"#{body['name']}\" for \"#{kapp_slug}\" kapp")
+      put("#{@api_url}/kapps/#{kapp_slug}/formTypes/#{encode(name)}", body, headers)
+    end    
+
     # Delete a form type on a Kapp
+    # The method is being depreciated and replaced with delete_formtype    
     #
     # @param kapp_slug [String] slug of the Kapp the form type belongs to
     # @param name [String] name of the form type
@@ -24,19 +48,46 @@ module KineticSdk
       @logger.info("Deleting form type \"#{name}\" from \"#{kapp_slug}\" kapp")
       delete("#{@api_url}/kapps/#{kapp_slug}/formTypes/#{encode(name)}", headers)
     end
+    
+    alias :delete_formtype :delete_form_type
+
+    def delete_form_type(kapp_slug, name, headers=default_headers)
+      logger.info "Deprecation Warning: delete_form_type method will be removed in a future version. Please use #delete_formtype"
+      delete_formtype(kapp_slug, name, headers=default_headers)
+    end
 
     # Delete all form types on a Kapp
+    # The method is being depreciated and replaced with delete_formtypes
     #
     # @param kapp_slug [String] slug of the Kapp the form types belongs to
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_form_types_on_kapp(kapp_slug, headers=default_headers)
-      (find_form_types_on_kapp(kapp_slug, {}, headers).content["formTypes"] || []).each do |form_type|
-        delete_form_type(kapp_slug, form_type['name'], headers)
+      (find_formtypes(kapp_slug, {}, headers).content["formTypes"] || []).each do |form_type|
+        delete_formtype(kapp_slug, form_type['name'], headers)
       end
     end
+    
+    alias :delete_formtypes :delete_form_types_on_kapp
+
+    def delete_form_types_on_kapp(kapp_slug, headers=default_headers)
+      logger.info "Deprecation Warning: delete_form_types_on_kapp method will be removed in a future version. Please use #delete_formtypes"
+      delete_formtypes(kapp_slug, headers=default_headers)
+    end    
+
+    # Retrieve a single form types for a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the form types belongs to
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_formtype(kapp_slug, name, params={}, headers=default_headers)
+      @logger.info("Finding the #{name}Form Type for \"#{kapp_slug}\" kapp")
+      get("#{@api_url}/kapps/#{kapp_slug}/formTypes/#{encode(name)}", params, headers)
+    end
 
     # Retrieve a list of all form types for a Kapp
+    # The method is being depreciated and replaced with find_formtypes
     #
     # @param kapp_slug [String] slug of the Kapp the form types belongs to
     # @param params [Hash] Query parameters that are added to the URL, such as +include+
@@ -46,6 +97,12 @@ module KineticSdk
       @logger.info("Finding Form Types for \"#{kapp_slug}\" kapp")
       get("#{@api_url}/kapps/#{kapp_slug}/formTypes", params, headers)
     end
+    
+    alias :find_formtypes :find_form_types_on_kapp
 
+    def find_form_types_on_kapp(kapp_slug, params={}, headers=default_headers)
+      logger.info "Deprecation Warning: find_form_types_on_kapp method will be removed in a future version. Please use #find_formtypes"
+      find_formtypes(kapp_slug, params={}, headers=default_headers)
+    end    
   end
 end

data/lib/kinetic_sdk/core/lib/platform_components.rb

@@ -79,7 +79,6 @@ module KineticSdk
     # Delete Agent Component
     #
     # @param agent_slug [String] the slug of the agent to retrieve
-    # @param params [Hash] Query parameters that are added to the URL, such as +include+
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_agent_component(agent_slug, headers = default_headers)

data/lib/kinetic_sdk/core/lib/submissions.rb

@@ -9,18 +9,19 @@ module KineticSdk
     #   - +origin+ - Origin ID of the submission to be added
     #   - +parent+ - Parent ID of the submission to be added
     #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
     # @param parameters [Hash] hash of query parameters to append to the URL
     #   - +include+ - comma-separated list of properties to include in the response
     #   - +completed+ - signals that the submission should be completed, default is false
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def add_submission(kapp_slug, form_slug, payload={}, parameters={}, headers=default_headers)
-      # initialize "values" if nil
-      payload["values"] = {} if payload["values"].nil?
       # set origin hash if origin was passed as a string
       payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
       # set parent hash if parent was passed as a string
       payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_new_submission_values(kapp_slug, form_slug, payload["values"])
       # build the uri with the encoded parameters
       uri = URI.parse("#{@api_url}/kapps/#{kapp_slug}/forms/#{form_slug}/submissions")
       uri.query = URI.encode_www_form(parameters) unless parameters.empty?
@@ -38,6 +39,7 @@ module KineticSdk
     #   - +origin+ - Origin ID of the submission to be added
     #   - +parent+ - Parent ID of the submission to be added
     #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
     # @param parameters [Hash] hash of query parameters to append to the URL
     #   - +include+ - comma-separated list of properties to include in the response
     #   - +staged+ - Indicates whether field validations and page advancement should occur, default is false
@@ -45,12 +47,12 @@ module KineticSdk
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def add_submission_page(kapp_slug, form_slug, page_name, payload={}, parameters={}, headers=default_headers)
-      # initialize "values" if nil
-      payload["values"] = {} if payload["values"].nil?
       # set origin hash if origin was passed as a string
       payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
       # set parent hash if parent was passed as a string
       payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_new_submission_values(kapp_slug, form_slug, payload["values"])
       # add the page name to the parameters
       parameters["page"] = page_name
       # build the uri with the encoded parameters
@@ -69,17 +71,18 @@ module KineticSdk
     #   - +origin+ - Origin ID of the submission to be patched
     #   - +parent+ - Parent ID of the submission to be patched
     #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def patch_new_submission(kapp_slug, form_slug, payload={}, headers=default_headers)
       # set the currentPage hash if currentPage was passed as a string
       payload["currentPage"] = { "name" => payload["currentPage"] } if payload["currentPage"].is_a? String
-      # initialize "values" if nil
-      payload["values"] = {} if payload["values"].nil?
       # set origin hash if origin was passed as a string
       payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
       # set parent hash if parent was passed as a string
       payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_new_submission_values(kapp_slug, form_slug, payload["values"])
       # Create the submission
       @logger.info("Patching a submission in the \"#{form_slug}\" Form.")
       patch("#{@api_url}/kapps/#{kapp_slug}/forms/#{form_slug}/submissions", payload, headers)
@@ -92,17 +95,18 @@ module KineticSdk
     #   - +origin+ - Origin ID of the submission to be patched
     #   - +parent+ - Parent ID of the submission to be patched
     #   - +values+ - hash of field values for the submission
+    #     - attachment fields contain an Array of Hashes. Each hash represents an attachment answer for the field. The hash must include a `path` property with a value to represent the local file location.)
     # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def patch_existing_submission(submission_id, payload={}, headers=default_headers)
       # set the currentPage hash if currentPage was passed as a string
       payload["currentPage"] = { "name" => payload["currentPage"] } if payload["currentPage"].is_a? String
-      # initialize "values" if nil
-      payload["values"] = {} if payload["values"].nil?
       # set origin hash if origin was passed as a string
       payload["origin"] = { "id" => payload["origin"] } if payload["origin"].is_a? String
       # set parent hash if parent was passed as a string
       payload["parent"] = { "id" => payload["parent"] } if payload["parent"].is_a? String
+      # prepare any attachment values
+      payload["values"] = prepare_updated_submission_values(submission_id, payload["values"])
       # Create the submission
       @logger.info("Patching a submission with id \"#{submission_id}\"")
       patch("#{@api_url}/submissions/#{submission_id}", payload, headers)
@@ -211,5 +215,59 @@ module KineticSdk
       put("#{@api_url}/submissions/#{encode(submission_id)}", body, headers)
     end
 
+    private
+
+    # Prepares new submission values for attachment fields
+    #
+    # @param kapp_slug [String] kapp slug
+    # @param form_slug [String] form slug
+    # @param values [Hash] hash of values being submitted
+    # @return [Hash] hash of values with attachment paths replaced with uploaded file information
+    def prepare_new_submission_values(kapp_slug, form_slug, values)
+      file_upload_url = "#{@api_url.gsub('/app/api/v1','')}/#{kapp_slug}/#{form_slug}/files"
+      prepare_submission_values(values, file_upload_url)
+    end
+
+    # Prepares updated submission values for attachment fields
+    #
+    # @param submission_id [String] id of the Submission
+    # @param values [Hash] hash of values being submitted
+    # @return [Hash] hash of values with attachment paths replaced with uploaded file information
+    def prepare_updated_submission_values(submission_id, values)
+      file_upload_url = "#{@api_url.gsub('/app/api/v1','')}/submissions/#{submission_id}/files"
+      prepare_submission_values(values, file_upload_url)
+    end
+
+    # Prepares submission values for attachment fields
+    #
+    # @param values [Hash] hash of values being submitted
+    # @param file_upload_url [String] url to post attachments
+    # @return [Hash] hash of values with attachment paths replaced with uploaded file information
+    def prepare_submission_values(values, file_upload_url)
+      # initialize the values
+      values = {} if values.nil?
+      # handle attachment values
+      values.each do |field, value|
+        # if the value contains an array of files
+        if value.is_a?(Array) && !value.empty? && value.first.is_a?(Hash) && value.first.has_key?('path')
+          value.each_with_index do |file, index|
+            # upload the file to the server
+            file_upload_response = post_multipart(
+              file_upload_url,
+              { "package" => File.new(file['path']) },
+              default_headers)
+            # update the value with the file upload response
+            if file_upload_response.status == 200
+              values[field][index] = file_upload_response.content.first
+            else
+              raise "Attachment file upload failed: (#{file_upload_response.status}) #{file_upload_response.content_string}"
+            end
+          end
+        end
+      end
+      # return the values
+      values
+    end
+
   end
 end

data/lib/kinetic_sdk/core/lib/teams.rb

@@ -18,7 +18,6 @@ module KineticSdk
       # either add or update the attribute value
       exists = false
       attributes.each do |attribute|
-        @logger.info("Attribute: #{attribute.inspect}")
         # if the attribute already exists, update it
         if attribute["name"] == attribute_name
           attribute["values"] = attribute_value.is_a?(Array) ? attribute_value : [ attribute_value ]

data/lib/kinetic_sdk/core/lib/webapis.rb

@@ -0,0 +1,144 @@
+module KineticSdk
+  class Core
+
+    # Add a Web API on the Space
+    #
+    # @param body [Hash] hash of Web API properties
+    #   - +method+ - The method of the Web API - "GET", "POST", "PUT", or "DELETE"
+    #   - +slug+ - The slug of the Web API
+    #   - +securityPolicies+ - [Array] Array of hashes
+    #   -  - +endpoint+ - "Execution"
+    #   -  - +name+ - Name of an existing Space Security Definition
+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_space_webapi(body, headers=default_headers)
+      raise StandardError.new "Web API properties is not valid, must be a Hash." unless body.is_a? Hash
+      @logger.info("Adding the \"#{body['slug']}\" to the Space.")
+      post("#{@api_url}/webApis", body, headers)
+    end
+    
+    # Add a Web API on a Kapp
+    #
+    # @param kapp_slug [String] the Kapp slug
+    # @param body [Hash] hash of Web API properties
+    #   - +method+ - The method of the Web API - "GET", "POST", "PUT", or "DELETE"
+    #   - +slug+ - The slug of the Web API
+    #   - +securityPolicies+ - [Array] Array of hashes
+    #   -  - +endpoint+ - "Execution"
+    #   -  - +name+ - Name of an existing Space Security Definition
+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def add_kapp_webapi(kapp_slug, body, headers=default_headers)
+      raise StandardError.new "Web API properties is not valid, must be a Hash." unless body.is_a? Hash
+      @logger.info("Adding the \"#{body['slug']}\" to the \"#{kapp_slug}\" Kapp.")
+      post("#{@api_url}/kapps/#{kapp_slug}/webApis", body, headers)
+    end
+    
+    # Find all Web APIs for the Space
+    #
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_space_webapis(params={}, headers=default_headers)
+      @logger.info("Finding all Web APIs on the Space")
+      get("#{@api_url}/webApis", params, headers)
+    end
+    
+    # Find a single Web API on the Space
+    #
+    # @param slug [String] slug of the Web API
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_space_webapi(slug, params={}, headers=default_headers)
+      @logger.info("Finding the \"#{slug}\" Web API on the Space")
+      get("#{@api_url}/webApis/#{slug}", params, headers)
+    end  
+    
+    # Find all Web APIs for a Kapp
+    #
+    # @param kapp_slug [String] the Kapp slug
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_kapp_webapis(kapp_slug, params={}, headers=default_headers)
+      @logger.info("Finding all Web APIs on the \"#{kapp_slug}\" Kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/webApis", params, headers)
+    end    
+    
+    # Find a single Web API on the Kapp
+    #
+    # @param kapp_slug [String] the Kapp slug
+    # @param slug [String] slug of the Web API
+    # @param params [Hash] Query parameters that are added to the URL, such as +include+
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def find_kapp_webapi(kapp_slug, slug, params={}, headers=default_headers)
+      @logger.info("Finding the \"#{slug}\" Web API on the \"#{kapp_slug}\" Kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/webApis/#{slug}", params, headers)
+    end
+    
+    # Update a Web API on the Space
+    #
+    # All of the Web API properties are optional.  Only the properties provided
+    # in the Hash will be updated, the other properties will retain their
+    # current values.
+    #
+    # @param slug [String] the slug of the Web API
+    # @param body [Hash] hash of Web API properties
+    #   - +method+ - The method of the Web API - "GET", "POST", "PUT", or "DELETE"
+    #   - +slug+ - The slug of the Web API
+    #   - +securityPolicies+ - [Array] Array of hashes
+    #   -  - +endpoint+ - "Execution"
+    #   -  - +name+ - Name of an existing Space Security Definition
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def update_space_webapi(slug, body, headers=default_headers)
+      @logger.info("Updating the \"#{slug}\" Web API on the Space.")
+      put("#{@api_url}/webApis/#{slug}", body, headers)
+    end
+    
+    # Update a Web API on a Kapp
+    #
+    # All of the Web API properties are optional.  Only the properties provided
+    # in the Hash will be updated, the other properties will retain their
+    # current values.
+    #
+    # @param kapp_slug [String] the Kapp slug
+    # @param slug [String] the slug of the Web API
+    # @param body [Hash] hash of Web API properties
+    #   - +method+ - The method of the Web API - "GET", "POST", "PUT", or "DELETE"
+    #   - +slug+ - The slug of the Web API
+    #   - +securityPolicies+ - [Array] Array of hashes
+    #   -  - +endpoint+ - "Execution"
+    #   -  - +name+ - Name of an existing Space Security Definition
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def update_kapp_webapi(kapp_slug, slug, body, headers=default_headers)
+      @logger.info("Updating the \"#{slug}\" Web API on the \"#{kapp_slug}\" Kapp.")
+      put("#{@api_url}/kapps/#{kapp_slug}/webApis/#{slug}", body, headers)
+    end
+    
+    # Delete a Web API on the Space
+    # @param slug [String] the slug of the Web API
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def delete_space_webapi(slug, headers=default_headers)
+      @logger.info("Deleting the \"#{slug}\" Web API on the Space.")
+      delete("#{@api_url}/webApis/#{slug}", headers)
+    end
+    
+    # Delete a Web API on a Kapp
+    # @param kapp_slug [String] the Kapp slug
+    # @param slug [String] the slug of the Web API
+    # @param headers [Hash] hash of headers to send, default is basic authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def delete_kapp_webapi(kapp_slug, slug, headers=default_headers)
+      @logger.info("Deleting the \"#{slug}\" Web API on the \"#{kapp_slug}\" Kapp.")
+      delete("#{@api_url}/kapps/#{kapp_slug}/webApis/#{slug}", headers)
+    end    
+    
+  end
+end

data/lib/kinetic_sdk/core/lib/webhooks.rb

@@ -196,7 +196,7 @@ module KineticSdk
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_webhook_on_kapp(kapp_slug, name, headers=default_headers)
       @logger.info("Deleting the #{name} webhook on the #{kapp_slug}\ kapp.")
-      delete(URI.encode("#{@api_url}/kapps/#{kapp_slug}/webhooks/#{encode(name)}"), headers)
+      delete("#{@api_url}/kapps/#{kapp_slug}/webhooks/#{encode(name)}", headers)
     end
 
     # Delete a webhook on space

data/lib/kinetic_sdk/task/lib/handlers.rb

@@ -18,7 +18,7 @@ module KineticSdk
     def delete_handlers(headers=header_basic_auth)
       @logger.info("Deleting all handlers")
       (find_handlers(headers).content['handlers'] || []).each do |handler|
-        delete("#{@api_url}/handlers/#{handler['definition_id']}", headers)
+        delete("#{@api_url}/handlers/#{handler['definitionId']}", headers)
       end
     end
 

data/lib/kinetic_sdk/task/lib/sources.rb

@@ -49,7 +49,7 @@ module KineticSdk
     # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
     def delete_sources(headers=header_basic_auth)
       @logger.info("Deleting all sources")
-      (find_sources(headers).content['sources'] || []).each do |source|
+      (find_sources(headers).content["sourceRoots"] || []).each do |source|
         delete("#{@api_url}/sources/#{encode(source['name'])}", headers)
       end
     end

data/lib/kinetic_sdk/utils/kinetic-export-utils.rb

@@ -140,11 +140,16 @@ module KineticSdk
 
         # If this is not the "root" object
         if object_path != '' && !file_contents.empty?
+          # Remove all `/` and `\` characters with ``
+          # Replace all `.` with `/`
+          # Replace all `::` with `-` (this ensures nested Teams/Categories maintain a separator)
+          # Replace all non-slug characters with ``
+          filename = "#{core_path}/#{object_path.gsub('/\\', '').gsub('.', '/').gsub(/::/, '-').gsub(/[^ a-zA-Z0-9_\-\/]/, '')}.json"
           # Write the file_contents based upon the
-          filename = "#{core_path}/#{object_path.gsub('.', '/')}.json"
           write_object_to_file(filename, file_contents)
         end
 
+
         # For each of the child objects
         child_objects.each do |key, child_object|
           # Process the export for that object (recursively)

data/lib/kinetic_sdk/utils/kinetic-http.rb

@@ -634,9 +634,9 @@ module KineticSdk
       # @option http_options [Fixnum] :max_redirects optional - max number of times to redirect
       # @option http_options [Fixnum] :gateway_retry_limit optional - max number of times to retry a bad gateway
       # @option http_options [Float] :gateway_retry_delay optional - number of seconds to delay before retrying a bad gateway
-      def stream_download_to_file(file_path, url, params={}, headers={}, http_options=@http_options)
+      def stream_download_to_file(file_path, url, params={}, headers={}, http_options=@options)
         # Determine if redirection is involved
-        url = redirect_url(url, params, headers, max_redirects)
+        url = redirect_url(url, params, headers, http_options)
         # parse the URL
         uri = URI.parse(url)
   
@@ -645,15 +645,17 @@ module KineticSdk
         # build the http object
         http = build_http(uri)
   
-        # stream the attachment
-        file = File.open(file_path, "wb")
+        # prepare the download
+        file = nil
         file_name = File.basename(file_path)
         response_code = nil
         message = nil
         begin
+          # stream the attachment
           http.request_get(uri.request_uri, headers) do |response|
             response_code = response.code
             if response_code == "200"
+              file = File.open(file_path, "wb")
               response.read_body { |chunk| file.write(chunk) }
             else
               message = response.body
@@ -668,8 +670,9 @@ module KineticSdk
         rescue StandardError => e
           @logger.error("Failed to export file attachment \"#{file_name}\": (#{e})")
         ensure
-          file.close()
+          file.close() unless file.nil?
         end
+        message
       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.9"
+  VERSION = "5.0.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.9
+  version: 5.0.14
 platform: ruby
 authors:
 - Kinetic Data
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -17,8 +17,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.7
   name: slugify
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -31,8 +31,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.0.0
   name: multipart-post
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -45,8 +45,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
   name: mime-types
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -59,8 +59,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.12.1
   name: parallel
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -73,8 +73,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.9.0
   name: ruby-progressbar
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -87,8 +87,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.1.1
   name: kontena-websocket-client
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
@@ -101,8 +101,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.17'
   name: bundler
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -115,8 +115,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 13.0.1
   name: rake
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -129,8 +129,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.25
   name: yard
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -362,6 +362,7 @@ files:
 - lib/kinetic_sdk/core/lib/system_api.rb
 - lib/kinetic_sdk/core/lib/teams.rb
 - lib/kinetic_sdk/core/lib/users.rb
+- lib/kinetic_sdk/core/lib/webapis.rb
 - lib/kinetic_sdk/core/lib/webhook_jobs.rb
 - lib/kinetic_sdk/core/lib/webhooks.rb
 - lib/kinetic_sdk/discussions/discussions-sdk.rb
@@ -422,8 +423,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 3.0.6
 signing_key:
 specification_version: 4
 summary: Ruby SDK for Kinetic Data application APIs