kinetic_sdk 5.0.28 → 5.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b09563966c2fd8fb0733a8ae84b2c5300e076d4606571e368bbd02cd8c77edb
-  data.tar.gz: b834a8806f2f95eae015fc5c89764eaedc58cf85889d9ec9562501f7b48c9234
+  metadata.gz: 054f33cf19229075e84310cbec30fd1e7273dcb7b170ca72b47ce3ac2e4247e1
+  data.tar.gz: f0f73ed401f108470103e98e2ac7463199cfcd499127cc9e49123a882dee6000
 SHA512:
-  metadata.gz: 10a9c65096a5404c49e497b29a9f4c226b98eb4c8a17471a45cb2a5c7233ad3fdf3fa9be4ede7e5050598adab313f02f60027ddb9e8bce6a4823aa07b2fa6e57
-  data.tar.gz: fe578a51d97965d33c093df1240db88d21aa77e28d41eeb762f46cf3b4eb293c3f23dd392d53d0b6bf0c1cf26087258b6b8ff653a0fa497c14cc10ee1832d39f
+  metadata.gz: 8288d007b340bf2f81b05b2504ff4a2af7892966ea5319910916aa5566e32897b8353ccc4963df962cb8f8dbc6460b1e3c25e2586ad3a049d60f76ad441439da
+  data.tar.gz: 9f274fe9504a7121b73dfe89d6fa90a87e1154bf2a1e30503726c7847793e4323ce2edf3357372f6bdfe9f657a62e2a28d38d636e3b029ccd56b25d3372ccdf9

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [5.0.30](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.30) (2025-10-02)
+
+**Implemented enhancements:**
+
+- Add import/export methods for WebAPIs.
+
+## [5.0.29](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.29) (2025-01-11)
+
+**Implemented enhancements:**
+
+- Fix integrator sdk methods for executing and inspecting operations.
+- Fix integrator sdk methods for testing connections.
+
 ## [5.0.28](https://github.com/kineticdata/kinetic-sdk-rb/tree/5.0.28) (2025-01-10)
 
 **Implemented enhancements:**

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

@@ -17,7 +17,7 @@ module KineticSdk
       @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
@@ -35,7 +35,7 @@ module KineticSdk
       @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+
@@ -45,7 +45,7 @@ module KineticSdk
       @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
@@ -55,8 +55,8 @@ module KineticSdk
     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  
-    
+    end
+
     # Find all Web APIs for a Kapp
     #
     # @param kapp_slug [String] the Kapp slug
@@ -66,8 +66,8 @@ module KineticSdk
     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    
-    
+    end
+
     # Find a single Web API on the Kapp
     #
     # @param kapp_slug [String] the Kapp slug
@@ -79,7 +79,7 @@ module KineticSdk
       @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
@@ -99,7 +99,7 @@ module KineticSdk
       @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
@@ -120,8 +120,9 @@ module KineticSdk
       @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
@@ -129,8 +130,9 @@ module KineticSdk
       @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
@@ -138,7 +140,66 @@ module KineticSdk
     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
+
+    # Export a single Web API on the Space
+    #
+    # @param slug [String] 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 export_space_webapi(slug, headers=default_headers)
+      @logger.info("Exporting the \"#{slug}\" Web API on the Space")
+      get("#{@api_url}/webApis/#{slug}/export", {}, headers)
+    end
+
+    # Import a Web API on the Space
+    #
+    # @param body [Hash] hash of Web API properties. Must contain one of either +treeXml+ or +treeJson+, but not both.
+    #   - +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
+    #   - +treeJson+ - JSON string representing the Web API's tree structure
+    #   - +treeXml+ - XML string representing the Web API's tree structure
+    # @param force_overwrite [Boolean] whether to overwrite a WebAPI if it exists, 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 import_space_webapi(body, force_overwrite=false, headers=default_headers)
+      raise StandardError.new "Web API properties is not valid, must be a Hash." unless body.is_a? Hash
+      @logger.info("Importing the \"#{body['slug']}\" Web API to the Space.")
+      post("#{@api_url}/webApiImport?force=#{force_overwrite}", body, headers)
+    end
+
+    # Export a single 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 export_kapp_webapi(kapp_slug, slug, headers=default_headers)
+      @logger.info("Exporting the \"#{slug}\" Web API on the \"#{kapp_slug}\" Kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/webApis/#{slug}/export", {}, headers)
+    end
+
+    # Import a Web API on a Kapp
+    #
+    # @param kapp_slug [String] the Kapp slug
+    # @param body [Hash] hash of Web API properties. Must contain one of either +treeXml+ or +treeJson+, but not both.
+    #   - +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
+    #   - +treeJson+ - JSON string representing the Web API's tree structure
+    #   - +treeXml+ - XML string representing the Web API's tree structure
+    # @param force_overwrite [Boolean] whether to overwrite a WebAPI if it exists, 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 import_kapp_webapi(kapp_slug, body, force_overwrite=false, headers=default_headers)
+      raise StandardError.new "Web API properties is not valid, must be a Hash." unless body.is_a? Hash
+      @logger.info("Importing the \"#{body['slug']}\" Web API to the \"#{kapp_slug}\" Kapp.")
+      post("#{@api_url}/kapps/#{kapp_slug}/webApiImport?force=#{force_overwrite}", body, headers)
+    end
   end
 end

data/lib/kinetic_sdk/integrator/lib/connections.rb

@@ -58,5 +58,25 @@ module KineticSdk
       put("#{@api_url}/connections/#{connection_id}", properties, headers)
     end
 
+    # Test an unsaved Connection
+    #
+    # @param properties [Hash] connection properties to test
+    # @param headers [Hash] hash of headers to send, default is bearer authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def test_unsaved_connection(properties={}, headers=default_jwt_headers)
+      @logger.info("Testing unsaved connection")
+      post("#{@api_url}/test", properties, headers)
+   end
+
+   # Test a saved Connection
+   #
+   # @param connection_id [String] id of the Connection
+   # @param properties [Hash] connection properties to test
+   # @param headers [Hash] hash of headers to send, default is bearer authentication and accept JSON content type
+   # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+   def test_saved_connection(connection_id, properties={}, headers=default_jwt_headers)
+     @logger.info("Testing saved connection: #{connection_id}")
+     post("#{@api_url}/connections/#{connection_id}/test", properties, headers)
+  end
   end
 end

data/lib/kinetic_sdk/integrator/lib/operations.rb

@@ -65,5 +65,38 @@ module KineticSdk
       put("#{@api_url}/connections/#{connection_id}/operations/#{operation_id}", properties, headers)
     end
 
+    # Execute an Operation
+    #
+    # @param connection_id [String] id of the Connection
+    # @param operation_id [String] id of the Operation
+    # @param parameters [Hash] operation execution parameters
+    # @param debug [boolean] execute in debug mode
+    # @param headers [Hash] hash of headers to send, default is bearer authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def execute_operation(connection_id, operation_id, parameters={}, debug=false, headers=default_jwt_headers)
+      @logger.info("Executing operation #{operation_id}")
+      payload = {
+        "connectionId" => connection_id,
+        "operationId" => operation_id,
+        "parameters" => parameters
+      }
+      url = "#{@api_url}/execute"
+      url = "#{url}?debug=true" if debug
+      post(url, payload, headers)
+    end
+
+    # Inspect an Operation
+    #
+    # @param operation_id [String] id of the Operation
+    # @param headers [Hash] hash of headers to send, default is bearer authentication and accept JSON content type
+    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
+    def inspect_operation(operation_id, headers=default_jwt_headers)
+      @logger.info("Inspecting operation #{operation_id}")
+      payload = {
+        "operationId" => operation_id
+      }
+      url = "#{@api_url}/inspect"
+      post(url, payload, headers)
+    end
   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.28"
+  VERSION = "5.0.30"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.28
+  version: 5.0.30
 platform: ruby
 authors:
 - Kinetic Data
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-10 00:00:00.000000000 Z
+date: 2025-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slugify
@@ -663,7 +663,6 @@ files:
 - lib/kinetic_sdk/filehub/lib/filestores.rb
 - lib/kinetic_sdk/integrator/integrator-sdk.rb
 - lib/kinetic_sdk/integrator/lib/connections.rb
-- lib/kinetic_sdk/integrator/lib/executions.rb
 - lib/kinetic_sdk/integrator/lib/metadata.rb
 - lib/kinetic_sdk/integrator/lib/operations.rb
 - lib/kinetic_sdk/task/lib/access_keys.rb

data/lib/kinetic_sdk/integrator/lib/executions.rb

@@ -1,38 +0,0 @@
-module KineticSdk
-  class Integrator
-
-    # Execute an Operation
-    #
-    # @param connection_id [String] id of the Connection
-    # @param operation_id [String] id of the Operation
-    # @param parameters [Hash] operation execution parameters
-    # @param debug [boolean] execute in debug mode
-    # @param headers [Hash] hash of headers to send, default is bearer authentication and accept JSON content type
-    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
-    def execute_operation(connection_id, operation_id, parameters={}, debug=false, headers=default_jwt_headers)
-      @logger.info("Executing operation #{operation_id}")
-      payload = {
-        "connection" => connection_id,
-        "operation" => operation_id,
-        "parameters" => parameters
-      }
-      url = "#{@api_url}/execute"
-      url = "#{url}?debug=true" if debug
-      post(url, payload, headers)
-    end
-
-    # Inspect an Operation
-    #
-    # @param operation_id [String] id of the Operation
-    # @param headers [Hash] hash of headers to send, default is bearer authentication and accept JSON content type
-    # @return [KineticSdk::Utils::KineticHttpResponse] object, with +code+, +message+, +content_string+, and +content+ properties
-    def inspect_operation(operation_id, headers=default_jwt_headers)
-      @logger.info("Inspecting operation #{operation_id}")
-      payload = {
-        "operation" => operation_id
-      }
-      url = "#{@api_url}/inspect"
-      post(url, payload, headers)
-    end
-  end
-end