kinetic_sdk 0.1.1 → 1.0.0

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

@@ -0,0 +1,91 @@
+module KineticSdk
+  class Agent
+
+    # Add Filestore
+    #
+    # @param space [String] slug of the space
+    # @param body [Hash] properties associated to the Filestore
+    #   - +adapterClass+
+    #   - +name+
+    #   - +slug+
+    #   - +properties+
+    # @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_filestore(space, body, headers=default_headers)
+      @logger.info("Adding the \"#{body['name']}\" filestore in the \"#{space}\" space.")
+      post("#{@api_url}/spaces/#{space}/filestores", body, headers)
+    end
+
+    # Delete a Filestore
+    #
+    # @param space [String] slug of the space
+    # @param slug [String] slug of the Filestore
+    # @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_filestore(space, slug, headers=default_headers)
+      @logger.info("Deleting the \"#{slug}\" filestore in the \"#{space}\" space.")
+      delete("#{@api_url}/spaces/#{space}/filestores/#{slug}", headers)
+    end
+
+    # Find a filestore
+    #
+    # @param space [String] slug of the space
+    # @param slug [String] slug of the filestore
+    # @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_filestore(space, slug, params={}, headers=default_headers)
+      @logger.info("Finding the \"#{slug}\" filestore in the \"#{space}\" space.")
+      get("#{@api_url}/spaces/#{space}/filestores/#{slug}", params, headers)
+    end
+
+    # Update a filestore
+    #
+    # @param space [String] slug of the space
+    # @param slug [String] slug of the filestore
+    # @param body [Hash] properties of the filestore to update
+    # @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_filestore(space, slug, body={}, headers=default_headers)
+      @logger.info("Updating the \"#{slug}\" filestore in the \"#{space}\" space.")
+      put("#{@api_url}/spaces/#{space}/filestores/#{slug}", body, headers)
+    end
+
+    # Find all filestores in a space
+    #
+    # @param space [String] slug of 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_filestores(space, params={}, headers=default_headers)
+      @logger.info("Find all filestores in the \"#{space}\" space.")
+      get("#{@api_url}/spaces/#{space}/filestores", params, headers)
+    end
+
+    # Add Filestore to Space
+    #
+    # @param space [String] slug of the space
+    # @param body [Hash] properties associated to the Filestore
+    #   - +space+
+    #   - +adapterClass+
+    #   - +slug+
+    #   - +properties+
+    # @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_filestore(body, headers=default_headers)
+      @logger.info("Adding the \"#{body['name']}\" filestore in the \"#{body['space']}\" space.")
+      post("#{@api_url}/filestores", body, headers)
+    end
+
+    # Find all filestores in the system
+    #
+    # @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_all_filestores(params={}, headers=default_headers)
+      @logger.info("Find all filestores.")
+      get("#{@api_url}/filestores", params, headers)
+    end
+
+  end
+end

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

@@ -0,0 +1,91 @@
+module KineticSdk
+  class Agent
+
+    # Add Handler
+    #
+    # @param space [String] slug of the space
+    # @param body [Hash] properties associated to the Handler
+    #   - +adapterClass+
+    #   - +name+
+    #   - +slug+
+    #   - +properties+
+    # @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_handler(space, body, headers=default_headers)
+      @logger.info("Adding the \"#{body['name']}\" handler in the \"#{space}\" space.")
+      post("#{@api_url}/spaces/#{space}/handlers", body, headers)
+    end
+
+    # Delete a Handler
+    #
+    # @param space [String] slug of the space
+    # @param slug [String] slug of the Handler
+    # @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_handler(space, slug, headers=default_headers)
+      @logger.info("Deleting the \"#{slug}\" handler in the \"#{space}\" space.")
+      delete("#{@api_url}/spaces/#{space}/handlers/#{slug}", headers)
+    end
+
+    # Find a handler
+    #
+    # @param space [String] slug of the space
+    # @param slug [String] slug of the handler
+    # @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_handler(space, slug, params={}, headers=default_headers)
+      @logger.info("Finding the \"#{slug}\" handler in the \"#{space}\" space.")
+      get("#{@api_url}/spaces/#{space}/handlers/#{slug}", params, headers)
+    end
+
+    # Update a handler
+    #
+    # @param space [String] slug of the space
+    # @param slug [String] slug of the handler
+    # @param body [Hash] properties of the handler to update
+    # @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_handler(space, slug, body={}, headers=default_headers)
+      @logger.info("Updating the \"#{slug}\" handler in the \"#{space}\" space.")
+      put("#{@api_url}/spaces/#{space}/handlers/#{slug}", body, headers)
+    end
+
+    # Find all handlers in a space
+    #
+    # @param space [String] slug of 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_handlers(space, params={}, headers=default_headers)
+      @logger.info("Find all handlers in the \"#{space}\" space.")
+      get("#{@api_url}/spaces/#{space}/handlers", params, headers)
+    end
+
+    # Add Handler to Space
+    #
+    # @param space [String] slug of the space
+    # @param body [Hash] properties associated to the Handler
+    #   - +space+
+    #   - +definitionId+
+    #   - +slug+
+    #   - +properties+
+    # @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_handler(body, headers=default_headers)
+      @logger.info("Adding the \"#{body['name']}\" handler in the \"#{body['space']}\" space.")
+      post("#{@api_url}/handlers", body, headers)
+    end
+
+    # Find all handlers in the system
+    #
+    # @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_all_handlers(params={}, headers=default_headers)
+      @logger.info("Find all handlers.")
+      get("#{@api_url}/handlers", params, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/bridgehub/bridgehub-sdk.rb

@@ -10,7 +10,7 @@ module KineticSdk
     # Include the KineticHttpUtils module
     include KineticSdk::Utils::KineticHttpUtils
 
-    attr_reader :api_url, :username, :options, :password, :server, :version
+    attr_reader :api_url, :username, :options, :password, :server, :version, :logger
 
     # Initalize the BridgeHub SDK with the web server URL and configuration user
     # credentials, along with any custom option values.
@@ -28,8 +28,11 @@ module KineticSdk
     # @option opts [String] :password the password for the user
     # @option opts [Hash<Symbol, Object>] :options ({}) optional settings
     #
-    #   * :log_level (String) (_defaults to: off_) level of logging - off | info | debug | trace
-    #   * :max_redirects (Fixnum) (_defaults to: 10_) maximum number of redirects to follow
+    #   * :gateway_retry_limit (FixNum) (_defaults to: 5_) max number of times to retry a bad gateway
+    #   * :gateway_retry_delay (Float) (_defaults to: 1.0_) number of seconds to delay before retrying a bad gateway
+    #   * :log_level (String) (_defaults to: off_) level of logging - off | error | warn | info | debug
+    #   * :log_output (String) (_defaults to: STDOUT_) where to send output - STDOUT | STDERR
+    #   * :max_redirects (Fixnum) (_defaults to: 5_) maximum number of redirects to follow
     #   * :ssl_ca_file (String) full path to PEM certificate used to verify the server
     #   * :ssl_verify_mode (String) (_defaults to: none_) - none | peer
     #
@@ -69,6 +72,11 @@ module KineticSdk
 
       # process any individual options
       @options = options.delete(:options) || {}
+      # setup logging
+      log_level = @options[:log_level] || @options["log_level"]
+      log_output = @options[:log_output] || @options["log_output"]
+      @logger = KineticSdk::Utils::KLogger.new(log_level, log_output)
+
       @username = options[:username]
       @password = options[:password]
       @server = options[:app_server_url].chomp('/')

data/lib/kinetic_sdk/bridgehub/lib/access_keys.rb

@@ -11,7 +11,7 @@ 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_access_key(slug, payload, headers=default_headers)
-      info("Adding Access Key for Bridge \"#{slug}\"")
+      @logger.info("Adding Access Key for Bridge \"#{slug}\"")
       post("#{@api_url}/bridges/#{slug}/access-keys", payload, headers)
     end
 
@@ -22,7 +22,7 @@ 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 delete_access_key(slug, id, headers=default_headers)
-      info("Deleting Access Key #{id} for Bridge \"#{slug}\"")
+      @logger.info("Deleting Access Key #{id} for Bridge \"#{slug}\"")
       delete("#{@api_url}/bridges/#{slug}/access-keys/#{id}", headers)
     end
 
@@ -33,7 +33,7 @@ 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 find_access_keys(slug, params={}, headers=default_headers)
-      info("Finding Access Keys for Bridge \"#{slug}\"")
+      @logger.info("Finding Access Keys for Bridge \"#{slug}\"")
       get("#{@api_url}/bridges/#{slug}/access-keys", params, headers)
     end
 
@@ -45,7 +45,7 @@ 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 find_access_key(slug, id, params={}, headers=default_headers)
-      info("Finding Access Key \"#{id}\" for Bridge \"#{slug}\"")
+      @logger.info("Finding Access Key \"#{id}\" for Bridge \"#{slug}\"")
       get("#{@api_url}/bridges/#{slug}/access-keys/#{id}", params, headers)
     end
 
@@ -59,7 +59,7 @@ 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 update_access_key(slug, id, payload, headers=default_headers)
-      info("Updating Access Key \"#{id}\" for Bridge \"#{slug}\"")
+      @logger.info("Updating Access Key \"#{id}\" for Bridge \"#{slug}\"")
       put("#{@api_url}/bridges/#{slug}/access-keys/#{id}", payload, headers)
     end
 

data/lib/kinetic_sdk/bridgehub/lib/bridge.rb

@@ -13,7 +13,7 @@ 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_bridge(payload, headers=default_headers)
-      info("Adding Bridge \"#{payload['name']}\" with slug \"#{payload['slug']}\"")
+      @logger.info("Adding Bridge \"#{payload['name']}\" with slug \"#{payload['slug']}\"")
       post("#{@api_url}/bridges", payload, headers)
     end
 
@@ -23,7 +23,7 @@ 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 delete_bridge(slug, headers=default_headers)
-      info("Deleting Bridge \"#{slug}\"")
+      @logger.info("Deleting Bridge \"#{slug}\"")
       delete("#{@api_url}/bridges/#{slug}", headers)
     end
 
@@ -33,7 +33,7 @@ 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 find_bridges(params={}, headers=default_headers)
-      info("Finding Bridges")
+      @logger.info("Finding Bridges")
       get("#{@api_url}/bridges", params, headers)
     end
 
@@ -44,7 +44,7 @@ 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 find_bridge(slug, params={}, headers=default_headers)
-      info("Finding Bridge \"#{slug}\"")
+      @logger.info("Finding Bridge \"#{slug}\"")
       get("#{@api_url}/bridges/#{slug}", params, headers)
     end
 
@@ -61,7 +61,7 @@ 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 update_bridge(slug, payload, headers=default_headers)
-      info("Updating Bridge \"#{slug}\"")
+      @logger.info("Updating Bridge \"#{slug}\"")
       put("#{@api_url}/bridges/#{slug}", payload, headers)
     end
 

data/lib/kinetic_sdk/{request_ce/request-ce-sdk.rb → core/core-sdk.rb}

@@ -2,31 +2,35 @@ Dir[File.join(File.dirname(File.expand_path(__FILE__)), "lib", "**", "*.rb")].ea
 
 module KineticSdk
 
-  # RequestCe is a Ruby class that acts as a wrapper for the Kinetic Request CE REST API
-  # without having to make explicit HTTP requests.
+  # Core is a Ruby class that acts as a wrapper for the Core REST API without 
+  # having to make explicit HTTP requests.
   #
-  class RequestCe
+  class Core
 
     # Include the KineticHttpUtils module
     include KineticSdk::Utils::KineticHttpUtils
 
-    attr_reader :api_url, :username, :options, :password, :space_slug, :server, :version
+    # Include the KineticExportUtils module
+    include KineticSdk::Utils::KineticExportUtils
 
-    # Initalize the Request CE SDK with the web server URL, the space user
+    attr_reader :api_url, :username, :options, :password, :proxy_url,
+                :space_slug, :server, :version, :logger
+
+    # Initalize the Core SDK with the web server URL, the space user
     # username and password, along with any custom option values.
     #
-    # @param [Hash<Symbol, Object>] opts Kinetic Request CE properties
+    # @param [Hash<Symbol, Object>] opts Kinetic Core properties
     # @option opts [String] :config_file optional - path to the YAML configuration file
     #
-    #   * Ex: /opt/config/request-ce-configuration1.yaml
+    #   * Ex: /opt/config/core-configuration1.yaml
     #
-    # @option opts [String] :app_server_url the URL to the Kinetic Request CE web application
+    # @option opts [String] :app_server_url the URL to the Kinetic Core web application
     #
     #   * Must not be used when `:space_server_url` is also used.
     #   * If space_slug is provided, it will be appended to the URL as a path parameter
     #   * Ex: <http://192.168.0.1:8080/kinetic>
     #
-    # @option opts [String] :space_server_url the URL to the Kinetic Request CE space
+    # @option opts [String] :space_server_url the URL to the Kinetic Core space
     #
     #   * Must not be used when `app_server_url` is used
     #   * Typically used when using a proxy server that supports space slugs as subdomains
@@ -44,20 +48,23 @@ module KineticSdk
     # @option opts [String] :password the password for the user
     # @option opts [Hash<Symbol, Object>] :options ({}) optional settings
     #
-    #   * :log_level (String) (_defaults to: off_) level of logging - off | info | debug | trace
-    #   * :max_redirects (Fixnum) (_defaults to: 10_) maximum number of redirects to follow
+    #   * :gateway_retry_limit (FixNum) (_defaults to: 5_) max number of times to retry a bad gateway
+    #   * :gateway_retry_delay (Float) (_defaults to: 1.0_) number of seconds to delay before retrying a bad gateway
+    #   * :log_level (String) (_defaults to: off_) level of logging - off | error | warn | info | debug
+    #   * :log_output (String) (_defaults to: STDOUT_) where to send output - STDOUT | STDERR
+    #   * :max_redirects (Fixnum) (_defaults to: 5_) maximum number of redirects to follow
     #   * :ssl_ca_file (String) full path to PEM certificate used to verify the server
     #   * :ssl_verify_mode (String) (_defaults to: none_) - none | peer
     #
     # Example: using a configuration file
     #
-    #     KineticSdk::RequestCe.new({
+    #     KineticSdk::Core.new({
     #       config_file: "/opt/config1.yaml"
     #     })
     #
     # Example: space user properties hash
     #
-    #     KineticSdk::RequestCe.new({
+    #     KineticSdk::Core.new({
     #       app_server_url: "http://localhost:8080/kinetic",
     #       space_slug: "foo",
     #       username: "space-user-1",
@@ -71,7 +78,7 @@ module KineticSdk
     #
     # Example: system user properties hash
     #
-    #     KineticSdk::RequestCe.new({
+    #     KineticSdk::Core.new({
     #       app_server_url: "http://localhost:8080/kinetic",
     #       username: "admin",
     #       password: "password",
@@ -88,7 +95,7 @@ module KineticSdk
     #     #
     #     #   app_server_url: https://myapp.io
     #
-    #     KineticSdk::RequestCe.new({
+    #     KineticSdk::Core.new({
     #       space_server_url: "https://myapp.io/foo",
     #       space_slug: "foo",
     #       username: "space-user-1",
@@ -106,7 +113,7 @@ module KineticSdk
     #     #
     #     #   Ex: https://myapp.io/foo
     #
-    #     KineticSdk::RequestCe.new({
+    #     KineticSdk::Core.new({
     #       space_server_url: "https://foo.myapp.io",
     #       space_slug: "foo",
     #       username: "space-user-1",
@@ -135,16 +142,23 @@ module KineticSdk
 
       # process any individual options
       @options = options.delete(:options) || {}
+      # setup logging
+      log_level = @options[:log_level] || @options["log_level"]
+      log_output = @options[:log_output] || @options["log_output"]
+      @logger = KineticSdk::Utils::KLogger.new(log_level, log_output)
+
       @username = options[:username]
       @password = options[:password]
       @space_slug = options[:space_slug]
       if options[:app_server_url]
         @server = options[:app_server_url].chomp('/')
         @api_url = @server + (@space_slug.nil? ? "/app/api/v1" : "/#{@space_slug}/app/api/v1")
+        @proxy_url = @space_slug.nil? ? nil : "#{@server}/#{@space_slug}/app/components"
       else
         raise StandardError.new "The :space_slug option is required when using the :space_server_url option" if @space_slug.nil?
         @server = options[:space_server_url].chomp('/')
         @api_url = "#{@server}/app/api/v1"
+        @proxy_url = "#{@server}/app/components"
       end
       @version = 1
     end