kinetic_sdk 5.0.11 → 5.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bef4ef5b7a3772de01000faf66ca84663367f55adef418ec9ff0df0792e06df
-  data.tar.gz: c8f6a905d0564a853e1c4314296356afc2a3b165d85e87e590c18dd42e0368ad
+  metadata.gz: b48973a248ca9299a82e2f508af5fe67bea291f0b9a3b672c250fd963e96531b
+  data.tar.gz: b2403cc106dee26a0a4f11f4bfe9be956d8ca3e7130a429285109569e4d406b0
 SHA512:
-  metadata.gz: 8b44e5014b26f7fd8f9e89e5cebe8d5474e78e82295b6ff3a57d6efef437e8e3baef44a52578373a6b491d94b5e8ddfe7613af1a934021a98014cd05084d47fd
-  data.tar.gz: 97504862c6bab2088cad7ed1f71676ef1a7474340b55c17fefc7b24370d72a55da9b2f5623f7caa61a30b6ddbc41d5d61632f3571718a7965713ab121590c64d
+  metadata.gz: 9b511e848a0eb5ba0c452b2407edb60382ae1a1fc03ca286e88245f8bd94330b0327b503dc1c592e2eaefd2769a86df09409c42c54b4a99ed1e8be8b6cf69680
+  data.tar.gz: df63b8db823ae2d18b427534604ec14014f8e4263a303edb38bbfe62befe8cd0ed547c9cd8e0642e9d371fd2d3ad4140ad2c5bb31d9bde0f1821c922ac3fdda7

data/CHANGELOG.md

@@ -1,5 +1,65 @@
 # Change Log
 
+## [5.0.12](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.12) (2020-08-27)
+
+Added routes for webapis.
+
+## [5.0.11](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.11) (2020-08-24)
+
+Don't remove spaces in filenames when exporting items. Spaces are valid in Windows filenames.
+
+## [5.0.10](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.10) (2020-08-24)
+
+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)
+
+Bug Fixes.
+
+## [5.0.8](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.8) (2020-06-11)
+
+Bug Fixes.
+
+## [5.0.7](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.7) (2020-05-15)
+
+Bug Fixes.
+
+## [5.0.6](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.6) (2020-04-24)
+
+Bug Fixes.
+
+## [5.0.5](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.5) (2020-04-24)
+
+Bug Fixes.
+
+## [5.0.4](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.4) (2020-02-12)
+
+Bug Fixes.
+
+## [5.0.3](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.3) (2020-01-16)
+
+Bug Fixes.
+
+## [5.0.2](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.2) (2020-01-10)
+
+Bug Fixes.
+
+## [5.0.1](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.1) (2020-01-10)
+
+Bug Fixes.
+
+## [5.0.0](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/5.0.0) (2019-12-19)
+
+Bumped version to correspond with Kinetic Platform 5.0.0.
+
+## [1.0.2](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/1.0.2) (2019-12-18)
+
+Bug Fixes.
+
+## [1.0.1](https://github.com/kineticdata/kinetic-sdk-rb/releases/tag/1.0.1) (2019-12-17)
+
+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 **

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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.11
+  version: 5.0.12
 platform: ruby
 authors:
 - Kinetic Data
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -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