kinetic_sdk 5.0.4 → 5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9b3c58d40bc983f719f0c89d6091d90bdaf91560d1bbdf519699e3f97e055a7
-  data.tar.gz: 73cc0c037f8a2a8c1b4ae5dc4a2044d09d154db70a0969a89608e5dab2bec466
+  metadata.gz: d154c0b5265721082b7c8e54b2c21a9d0ed4f0e3600cb38c567f4784baa71050
+  data.tar.gz: c5f94353587b5b847308e380f0319817decdf11722915323a4e7ec2c71d5afdf
 SHA512:
-  metadata.gz: 7e8e2e838080dea431dc1b101c49fd674e4d4499cb55858cac8b9198a04b9d773f8442b83f66afe7b539551681b9b82cb6fd1236b85ad09e96d8991d9aa2ca88
-  data.tar.gz: 367dec28e45a1570e2e59d712754a4a2b86ec7a7e0c7cbc3ff89f1d89466938b2c9b7f95854d3edc31e64ae74e47c21f582482a3d01df900f8c8dc379c026c22
+  metadata.gz: 5a1a755cac85fe3d43cc086c575b236e05cd803763cab2c2461837b7f62b4f94d8d64d7eade8fdca2b905b7a11441bf0363bcd8c18eeb7464941ae605e6448ac
+  data.tar.gz: 382caaac8682ce681dcffbce0e2f811d6f1fffd03722c65cc8b134cfc829ac788eb78e1cc06402a675047103bc95194c9ac998ad58dd1cea74dd3778178544af

data/README.md

@@ -75,20 +75,21 @@ the SDK with the following code.
 require File.join(File.expand_path(File.dirname(__FILE__)), 'vendor', 'kinetic-sdk-rb', 'kinetic-sdk')
 ```
 
-### Kinetic Agent SDK example
+### Kinetic Core SDK example of a Space User
 
 ```ruby
-agent_sdk = KineticSdk::Agent.new({
-  app_server_url: "http://localhost:8080/kinetic-agent",
-  username: "configuration-user",
+space_sdk = KineticSdk::Core.new({
+  app_server_url: "http://localhost:8080/kinetic",
+  space_slug: "foo",
+  username: "space-user-1",
   password: "password",
   options: {
     log_level: "info",
     max_redirects: 3
   }
 })
-response = agent_sdk.find_all_bridges()
-bridges = response.content['bridges']
+response = space_sdk.find_kapps()
+kapps = response.content['kapps']
 
 puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
 puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
@@ -96,11 +97,11 @@ puts response.content         # Ruby Hash
 puts response.content_string  # JSON formatted response body
 ```
 
-### Kinetic BridgeHub SDK example
+### Kinetic Core SDK example of a System User
 
 ```ruby
-bridgehub_sdk = KineticSdk::Bridgehub.new({
-  app_server_url: "http://localhost:8080/kinetic-bridgehub",
+system_sdk = KineticSdk::Core.new({
+  app_server_url: "http://localhost:8080/kinetic",
   username: "configuration-user",
   password: "password",
   options: {
@@ -108,8 +109,7 @@ bridgehub_sdk = KineticSdk::Bridgehub.new({
     max_redirects: 3
   }
 })
-response = bridgehub_sdk.find_bridges()
-bridges = response.content['bridges']
+response = system_sdk.add_space('My Company Space', 'my-company')
 
 puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
 puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
@@ -117,20 +117,23 @@ puts response.content         # Ruby Hash
 puts response.content_string  # JSON formatted response body
 ```
 
-### Kinetic FileHub SDK example
+### Kinetic Core SDK example of a Subdomain
+
+This example requires a proxy server configured to rewrite the space slug subdomain to the expected Core API route.
 
 ```ruby
-filehub_sdk = KineticSdk::Filehub.new({
-  app_server_url: "http://localhost:8080/kinetic-filehub",
-  username: "configuration-user",
+space_sdk = KineticSdk::Core.new({
+  space_server_url: "https://foo.myapp.io",
+  space_slug: "foo",
+  username: "space-user-1",
   password: "password",
   options: {
     log_level: "info",
     max_redirects: 3
   }
 })
-response = filehub_sdk.find_filestores()
-filestores = response.content['filestores']
+response = space_sdk.find_kapps()
+kapps = response.content['kapps']
 
 puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
 puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
@@ -138,21 +141,20 @@ puts response.content         # Ruby Hash
 puts response.content_string  # JSON formatted response body
 ```
 
-### Kinetic Core SDK example of a Space User
+### Kinetic Task SDK example
 
 ```ruby
-space_sdk = KineticSdk::Core.new({
-  app_server_url: "http://localhost:8080/kinetic",
-  space_slug: "foo",
-  username: "space-user-1",
+task_sdk = KineticSdk::Task.new({
+  app_server_url: "http://localhost:8080/kinetic-task",
+  username: "user-1",
   password: "password",
   options: {
+    export_directory: "/opt/exports/task-server-a",
     log_level: "info",
     max_redirects: 3
   }
 })
-response = space_sdk.find_kapps()
-kapps = response.content['kapps']
+response = task_sdk.environment()
 
 puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
 puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
@@ -160,11 +162,11 @@ puts response.content         # Ruby Hash
 puts response.content_string  # JSON formatted response body
 ```
 
-### Kinetic Core SDK example of a System User
+### Kinetic Agent SDK example
 
 ```ruby
-system_sdk = KineticSdk::Core.new({
-  app_server_url: "http://localhost:8080/kinetic",
+agent_sdk = KineticSdk::Agent.new({
+  app_server_url: "http://localhost:8080/kinetic-agent",
   username: "configuration-user",
   password: "password",
   options: {
@@ -172,7 +174,8 @@ system_sdk = KineticSdk::Core.new({
     max_redirects: 3
   }
 })
-response = system_sdk.add_space('My Company Space', 'my-company')
+response = agent_sdk.find_all_bridges()
+bridges = response.content['bridges']
 
 puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
 puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
@@ -180,23 +183,20 @@ puts response.content         # Ruby Hash
 puts response.content_string  # JSON formatted response body
 ```
 
-### Kinetic Core SDK example of a Subdomain
-
-This example requires a proxy server configured to rewrite the space slug subdomain to the expected Core API route.
+### Kinetic BridgeHub SDK example
 
 ```ruby
-space_sdk = KineticSdk::Core.new({
-  space_server_url: "https://foo.myapp.io",
-  space_slug: "foo",
-  username: "space-user-1",
+bridgehub_sdk = KineticSdk::Bridgehub.new({
+  app_server_url: "http://localhost:8080/kinetic-bridgehub",
+  username: "configuration-user",
   password: "password",
   options: {
     log_level: "info",
     max_redirects: 3
   }
 })
-response = space_sdk.find_kapps()
-kapps = response.content['kapps']
+response = bridgehub_sdk.find_bridges()
+bridges = response.content['bridges']
 
 puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
 puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)
@@ -204,20 +204,20 @@ puts response.content         # Ruby Hash
 puts response.content_string  # JSON formatted response body
 ```
 
-### Kinetic Task SDK example
+### Kinetic FileHub SDK example
 
 ```ruby
-task_sdk = KineticSdk::Task.new({
-  app_server_url: "http://localhost:8080/kinetic-task",
-  username: "user-1",
+filehub_sdk = KineticSdk::Filehub.new({
+  app_server_url: "http://localhost:8080/kinetic-filehub",
+  username: "configuration-user",
   password: "password",
   options: {
-    export_directory: "/opt/exports/task-server-a",
     log_level: "info",
     max_redirects: 3
   }
 })
-response = task_sdk.environment()
+response = filehub_sdk.find_filestores()
+filestores = response.content['filestores']
 
 puts response.code            # String value of HTTP response code ("200", "400", "500", etc...)
 puts response.status          # Ruby Fixnum value of response.code (200, 400, 500, etc...)

data/kinetic_sdk.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "kontena-websocket-client", "0.1.1"
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 12.3.0"
+  spec.add_development_dependency "rake", "~> 13.0.1"
   spec.add_development_dependency "yard", "~> 0.9.20"
 
   spec.metadata["yard.run"] = "yri"

data/lib/kinetic_sdk/core/lib/categories.rb

@@ -1,6 +1,29 @@
 module KineticSdk
   class Core
 
+    # Retrieve a Category on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the category belongs to
+    # @param category_slug [String] slug of the the category to find
+    # @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_category_on_kapp(kapp_slug, category_slug, params={}, headers=default_headers)
+      @logger.info("Finding #{category_slug} Category on the #{kapp_slug} kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/categories/#{category_slug}", params, headers)
+    end
+
+    # Find Categories on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the category 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_categories(kapp_slug, params={}, headers=default_headers)
+      @logger.info("Finding Categories on the #{kapp_slug} kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/categories", params, headers)
+    end
+    
     # Add a category on a Kapp
     #
     # @param kapp_slug [String] slug of the Kapp the category belongs to
@@ -29,6 +52,32 @@ module KineticSdk
       @logger.info("Adding Categorization for \"#{kapp_slug}\" kapp")
       post("#{@api_url}/kapps/#{kapp_slug}/categorizations", body, headers)
     end
+    
+    # Update a category on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the category belongs to
+    # @param category_slug [String] slug of the the category to find    
+    # @param body [Hash] category properties
+    #   - +name+ - A descriptive name for the category
+    #   - +other details + -     
+    # @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_category_on_kapp(kapp_slug, category_slug, body, headers=default_headers)
+      raise StandardError.new "Category properties is not valid, must be a Hash." unless body.is_a? Hash
+      @logger.info("Updating Category \"#{body['name']}\" for \"#{kapp_slug}\" kapp")
+      put("#{@api_url}/kapps/#{kapp_slug}/categories/#{category_slug}", body, headers)
+    end
+    
+    # Delete a Category
+    #
+    # @param kapp_slug [String] slug of the Kapp the category belongs to
+    # @param category_slug [String] slug of the the category to delete    
+    # @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_category_on_kapp(kapp_slug, category_slug, headers=default_headers)
+      @logger.info("Deleting the #{category_slug} Category on the #{kapp_slug}\ kapp.")
+      delete("#{@api_url}/kapps/#{kapp_slug}/categories/#{category_slug}", headers)
+    end
 
   end
 end

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

@@ -81,6 +81,7 @@ module KineticSdk
         "space.teamAttributeDefinitions",
         "space.userAttributeDefinitions",
         "space.userProfileAttributeDefinitions",
+        "space.webApis.{slug}",
         "space.webhooks.{name}",
       )
       core_data = get("#{@api_url}/space", { 'export' => true}, headers).content
@@ -134,6 +135,7 @@ module KineticSdk
           if api_path == "/kapps"
             kapp_slug = resp.content["kapp"]["slug"]
             delete_security_policy_definitions(kapp_slug)
+            delete_form_types_on_kapp(kapp_slug)
           end
         end
       end

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

@@ -7,7 +7,7 @@ module KineticSdk
     #
     # @param team_name [String] the team name
     # @param attribute_name [String] the attribute name
-    # @param attribute_value [String] the attribute value
+    # @param attribute_value [String|Array] the attribute value(s)
     # @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_team_attribute(team_name, attribute_name, attribute_value, headers=default_headers)
@@ -21,14 +21,14 @@ module KineticSdk
         @logger.info("Attribute: #{attribute.inspect}")
         # if the attribute already exists, update it
         if attribute["name"] == attribute_name
-          attribute["values"] = [ attribute_value ]
+          attribute["values"] = attribute_value.is_a?(Array) ? attribute_value : [ attribute_value ]
           exists = true
         end
       end
       # add the attribute if it didn't exist
       attributes.push({
         "name" => attribute_name,
-        "values" => [ attribute_value ]
+        "values" => attribute_value.is_a?(Array) ? attribute_value : [ attribute_value ]
         }) unless exists
 
       # set the updated attributes list
@@ -108,6 +108,29 @@ module KineticSdk
       @logger.info("Finding the \"#{team_name}\" (#{team_slug}) Team.")
       get("#{@api_url}/teams/#{team_slug}", params, headers)
     end
-
+    
+    # Update a Team
+    #
+    # @param team_slug [String] slug of the Team to update
+    # @param body [Hash] category properties
+    #   - +name+ - Name of the team to be added
+    #   - +description+ - Description of the Team to be added 
+    # @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_team(team_slug, body, headers=default_headers)
+      raise StandardError.new "Team properties is not valid, must be a Hash." unless body.is_a? Hash
+      @logger.info("Updating Team #{team_slug}")
+      put("#{@api_url}/teams/#{team_slug}", body, headers)
+    end
+    
+    # Delete a Team
+    #
+    # @param team_slug [String] slug of the the team to delete    
+    # @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_team(team_slug, headers=default_headers)
+      @logger.info("Deleting the #{team_slug} Team.")
+      delete("#{@api_url}/teams/#{team_slug}", headers)
+    end
   end
 end

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

@@ -187,6 +187,26 @@ module KineticSdk
       @logger.info("Updating the \"#{name}\" webhook on the Space")
       put("#{@api_url}/webhooks/#{encode(name)}", webhook_properties, headers)
     end
+    
+    # Delete a webhook on a kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the webhook belongs to
+    # @param name [String] the webhook name
+    # @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_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)
+    end
+
+    # Delete a webhook on space
+    # @param name [String] the webhook name
+    # @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_webhook_on_space(name, headers=default_headers)
+      @logger.info("Deleting the #{name} webhook on the space.")
+      delete("#{@api_url}/webhooks/#{encode(name)}", 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.4"
+  VERSION = "5.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kinetic_sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.4
+  version: 5.0.5
 platform: ruby
 authors:
 - Kinetic Data
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slugify
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement