kinetic_sdk 5.0.13 → 5.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bd5047435e78a51884c4b0b9a9766e273637fe9e31134fda839ebd4b5c9f939
-  data.tar.gz: a22fb82511b3670bb86931fd0a57cea9ef91adc7ec4d0780f6f3c5f151a84eb6
+  metadata.gz: 67e6967468589fa6bfdf4a523663d1675053a618882337a2d3b001265a525c19
+  data.tar.gz: 32ffee19ba6489077e6102beea1c96a2bccbad93fcd1c5ee38291ecebc8aec9d
 SHA512:
-  metadata.gz: ea4237e58c4e40ee2b6c154efbec23d467a93d9ea83c0d0a798a53d987336c1fc9832ada3ea75527a74605ed36985f4e644876a345b4610cb74dd69d5574c971
-  data.tar.gz: b0901ed2b02c428e70eebaa6a260b16ca7f2f47aca26d020bdb79ab87de0f7e73205279a01bf9caba85b8b3f65e64662745247ae461ab29f2abddf2a91043e3d
+  metadata.gz: 02d1a9fba8f13cb36dfe03848c6ffe81fe0c8be5b4298380ff8f18e39539dae0d9e17df66f17197b279a3f0022757e719d19c24827ad7d155f95db4b56e09239
+  data.tar.gz: 492ecbe9146c29d23e11f3a36fcb3a3cb52c712a5a902d8f7dbbb22c94cdac6890a85d7623265a7901a22999ade8d4c026a2fb8a6e2671ac2c10d9fb62e31393

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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:**

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/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/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-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.13"
+  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.13
+  version: 5.0.14
 platform: ruby
 authors:
 - Kinetic Data
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 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:
     - - "~>"
@@ -423,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