kinetic_sdk 0.1.1

data/lib/kinetic_sdk/request_ce/lib/form_types.rb

@@ -0,0 +1,51 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a form type on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the form type belongs to
+    # @param body [Hash] form type properties
+    #   - +name+ - A descriptive name for the form type
+    # @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_form_type_on_kapp(kapp_slug, body, headers=default_headers)
+      raise StandardError.new "Form Type properties is not valid, must be a Hash." unless body.is_a? Hash
+      info("Adding Form Type \"#{body['name']}\" for \"#{kapp_slug}\" kapp")
+      post("#{@api_url}/kapps/#{kapp_slug}/formTypes", body, headers)
+    end
+
+    # Delete a form type on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the form type belongs to
+    # @param name [String] name of the form type
+    # @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_form_type(kapp_slug, name, headers=default_headers)
+      info("Deleting form type \"#{name}\" from \"#{kapp_slug}\" kapp")
+      delete("#{@api_url}/kapps/#{kapp_slug}/formTypes/#{encode(name)}", headers)
+    end
+
+    # Delete all form types on a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the form types belongs to
+    # @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_form_types_on_kapp(kapp_slug, headers=default_headers)
+      (find_form_types_on_kapp(kapp_slug, {}, headers).content["formTypes"] || []).each do |form_type|
+        delete_form_type(kapp_slug, form_type['name'], headers)
+      end
+    end
+
+    # Retrieve a list of all form types for a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp the form types 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_form_types_on_kapp(kapp_slug, params={}, headers=default_headers)
+      info("Finding Form Types for \"#{kapp_slug}\" kapp")
+      get("#{@api_url}/kapps/#{kapp_slug}/formTypes", params, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/jwt.rb

@@ -0,0 +1,55 @@
+module KineticSdk
+  class RequestCe
+
+    # Gets an authentication code
+    #
+    # @param client_id [String] the oauth client id
+    # @param client_secret [String] the oauth client secret
+    # @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 jwt_token(client_id, client_secret, headers=default_headers)
+      # retrieve the jwt code
+      jwt_code = jwt_code(client_id, headers)
+      # retrieve the jwt token
+      info("Retrieving JWT authorization token")
+      url = "#{@server}/app/oauth/token?grant_type=authorization_code&response_type=token&client_id=#{client_id}&code=#{jwt_code}"
+      token_headers = header_accept_json.merge(header_basic_auth(client_id, client_secret))
+      response = post(url, {}, token_headers, 0)
+
+      if response.status == 401
+        raise StandardError.new "#{response.message}, the oauth client id and secret are invalid."
+      elsif response.status == 200
+        response
+      else
+        raise StandardError.new "Unable to retrieve token: #{response}"
+      end
+    end
+
+    # Gets an authentication code.
+    #
+    # This method should really never need to be called externally.
+    #
+    # @param client_id [String] 
+    # @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 jwt_code(client_id, headers=default_headers)
+      info("Retrieving JWT authorization code")
+      url = "#{@server}/app/oauth/authorize?grant_type=authorization_code&response_type=code&client_id=#{client_id}"
+      response = post(url, {}, headers, -1)
+
+      if response.status == 401
+        raise StandardError.new "#{response.message}: #{response.content['error']}"
+      elsif response.status == 302
+        location = response.headers['location']
+        if location.nil?
+          raise StandardError.new "Unable to retrieve code: #{response.inspect}"
+        else
+          location.split("?code=").last.split("#/").first
+        end
+      else
+        raise StandardError.new "Unable to retrieve code #{response.inspect}"
+      end
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/kapp.rb

@@ -0,0 +1,93 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a Kapp
+    #
+    # @param kapp_name [String] name of the Kapp
+    # @param kapp_slug [String] slug of the Kapp
+    # @param properties [Hash] optional properties associated to the Kapp
+    #   - +afterLogoutPath+
+    #   - +bundlePath+
+    #   - +defaultFormDisplayPage+
+    #   - +defaultFormConfirmationPage+
+    #   - +defaultSubmissionLabelExpression+
+    #   - +displayType+
+    #   - +displayValue+
+    #   - +loginPage+
+    #   - +resetPasswordPage+
+    # @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(kapp_name, kapp_slug, properties={}, headers=default_headers)
+      properties.merge!({
+        "name" => kapp_name,
+        "slug" => kapp_slug
+      })
+      info("Adding the \"#{kapp_name}\" Kapp.")
+      post("#{@api_url}/kapps", properties, headers)
+    end
+
+    # Delete a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp
+    # @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(kapp_slug, headers=default_headers)
+      info("Deleting the \"#{kapp_slug}\" Kapp.")
+      delete("#{@api_url}/kapps/#{kapp_slug}", headers)
+    end
+
+    # Exports a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp
+    # @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(kapp_slug, headers=default_headers)
+      info("Exporting the \"#{kapp_slug}\" Kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}", { 'export' => true }, headers)
+    end
+
+    # Find Kapps
+    #
+    # @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_kapps(params={}, headers=default_headers)
+      info("Finding Kapps.")
+      get("#{@api_url}/kapps", params, headers)
+    end
+
+    # Find a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp
+    # @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(kapp_slug, params={}, headers=default_headers)
+      info("Finding Kapp \"#{kapp_slug}\"")
+      get("#{@api_url}/kapps/#{kapp_slug}", params, headers)
+    end
+
+    # Update a Kapp
+    #
+    # @param kapp_slug [String] slug of the Kapp
+    # @param properties [Hash] optional properties associated to the Kapp
+    #   - +afterLogoutPath+
+    #   - +bundlePath+
+    #   - +defaultFormDisplayPage+
+    #   - +defaultFormConfirmationPage+
+    #   - +defaultSubmissionLabelExpression+
+    #   - +displayType+
+    #   - +displayValue+
+    #   - +loginPage+
+    #   - +name+
+    #   - +resetPasswordPage+
+    #   - +slug+
+    # @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(kapp_slug, properties={}, headers=default_headers)
+      info("Updating the \"#{kapp_slug}\" Kapp.")
+      put("#{@api_url}/kapps/#{kapp_slug}", properties, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/meta.rb

@@ -0,0 +1,14 @@
+module KineticSdk
+  class RequestCe
+
+    # Retrieve Request CE application version
+    #
+    # @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 app_version(headers=default_headers)
+      info("Retrieving Request CE application version.")
+      get("#{@api_url}/version", {}, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/oauth.rb

@@ -0,0 +1,37 @@
+module KineticSdk
+  class RequestCe
+
+    # Add an OAuth client
+    #
+    # @param options [Hash] oauth client 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_oauth_client(options, headers=default_headers)
+      info("Adding the \"#{options['clientId']}\" OAuth client")
+      post("#{@api_url}/oauthClients", options, headers)
+    end
+
+    # Find OAuth client
+    #
+    # @param client_id [String] - oauth client identifier
+    # @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_oauth_client(client_id, params={}, headers=default_headers)
+      info("Finding OAuth Client \"#{client_id}\"")
+      get("#{@api_url}/oauthClients/#{encode(client_id)}", params, headers)
+    end
+
+    # Update an OAuth client
+    #
+    # @param client_id [String] - oauth client identifier
+    # @param options [Hash] oauth client 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 update_oauth_client(client_id, options, headers=default_headers)
+      info("Updating the \"#{client_id}\" OAuth client")
+      put("#{@api_url}/oauthClients/#{encode(client_id)}", options, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/security_policy_definitions.rb

@@ -0,0 +1,157 @@
+module KineticSdk
+  class RequestCe
+
+    # Add a Space security policy definition
+    #
+    # @param body [Hash] properties of the security policy definition
+    #   - +name+ - name of the security policy definition
+    #   - +message+ - message for the security policy definition
+    #   - +rule+ - rule for the security policy definition
+    #   - +type+ - type of the security policy 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_security_policy_definition(body, headers=default_headers)
+      info("Adding Space Security Policy Definition \"#{body['name']}\".")
+      # Create the space security policy definition
+      post("#{@api_url}/securityPolicyDefinitions", body, headers)
+    end
+
+    # Delete a Space security policy definition
+    #
+    # @param name [String] name of the security policy 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 delete_space_security_policy_definition(name, headers=default_headers)
+      info("Deleting Space Security Policy Definition \"#{name}\".")
+      # Delete the space security policy definition
+      delete("#{@api_url}/securityPolicyDefinitions/#{encode(name)}", headers)
+    end
+
+    # Delete all Space security policy definitions
+    #
+    # @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_security_policy_definitions(headers=default_headers)
+      (find_space_security_policy_definitions({}, headers).content["securityPolicyDefinitions"] || []).each do |s|
+        delete_space_security_policy_definition(s['name'], headers)
+      end
+    end
+
+    # Find all Space security policy definitions
+    #
+    # @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_security_policy_definitions(params={}, headers=default_headers)
+      info("Finding Space Security Policy Definitions.")
+      get("#{@api_url}/securityPolicyDefinitions", params, headers)
+    end
+
+    # Find a single Space security policy definition
+    #
+    # @param name [String] name of the security policy definition
+    # @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_security_policy_definition(name, params={}, headers=default_headers)
+      info("Finding Space Security Policy Definition \"#{name}\"")
+      get("#{@api_url}/securityPolicyDefinitions/#{encode(name)}", params, headers)
+    end
+  
+    # Update a Space security policy definition
+    #
+    # @param name [String] name of the security policy definition
+    # @param body [Hash] properties of the security policy definition
+    #   - +name+ - name of the security policy definition
+    #   - +message+ - message for the security policy definition
+    #   - +rule+ - rule for the security policy definition
+    #   - +type+ - type of the security policy 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_security_policy_definition(name, body, headers=default_headers)
+      info("Updating Space Security Policy Definition \"#{name}\"")
+      put("#{@api_url}/securityPolicyDefinitions/#{encode(name)}", body, headers)
+    end
+
+
+
+    # Add a Kapp security policy definition
+    #
+    # @param kapp_slug [String] slug of the kapp
+    # @param body [Hash] properties of the security policy definition
+    #   - +name+ - name of the security policy definition
+    #   - +message+ - message for the security policy definition
+    #   - +rule+ - rule for the security policy definition
+    #   - +type+ - type of the security policy 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_security_policy_definition(kapp_slug, body, headers=default_headers)
+      info("Adding Security Policy Definition \"#{body['name']}\" to the \"#{kapp_slug}\" kapp.")
+      # Create the kapp security policy definition
+      post("#{@api_url}/kapps/#{kapp_slug}/securityPolicyDefinitions", body, headers)
+    end
+
+    # Delete a Kapp security policy definition
+    #
+    # @param kapp_slug [String] slug of the kapp
+    # @param name [String] name of the security policy 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 delete_security_policy_definition(kapp_slug, name, headers=default_headers)
+      info("Deleting Security Policy Definition \"#{name}\" from the \"#{kapp_slug}\" kapp.")
+      # Delete the kapp security policy definition
+      delete("#{@api_url}/kapps/#{kapp_slug}/securityPolicyDefinitions/#{encode(name)}", headers)
+    end
+
+    # Delete all Kapp security policy definitions
+    #
+    # @param kapp_slug [String] slug of the kapp
+    # @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_security_policy_definitions(kapp_slug, headers=default_headers)
+      (find_security_policy_definitions(kapp_slug, {}, headers).content["securityPolicyDefinitions"] || []).each do |s|
+        delete_security_policy_definition(kapp_slug, s['name'], headers)
+      end
+    end
+
+    # Find all Kapp security policy definitions
+    #
+    # @param kapp_slug [String] slug of the kapp
+    # @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_security_policy_definitions(kapp_slug, params={}, headers=default_headers)
+      info("Listing Security Policy Definitions on the \"#{kapp_slug}\" kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/securityPolicyDefinitions", params, headers)
+    end
+
+    # Find a single Kapp security policy definition
+    #
+    # @param kapp_slug [String] slug of the kapp
+    # @param name [String] name of the security policy definition
+    # @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_security_policy_definition(kapp_slug, name, params={}, headers=default_headers)
+      info("Finding Security Policy Definition \"#{name}\" on the \"#{kapp_slug}\" kapp.")
+      get("#{@api_url}/kapps/#{kapp_slug}/securityPolicyDefinitions/#{encode(name)}", params, headers)
+    end
+
+    # Update a Kapp security policy definition
+    #
+    # @param kapp_slug [String] slug of the kapp
+    # @param name [String] name of the security policy definition
+    # @param body [Hash] properties of the security policy definition
+    #   - +name+ - name of the security policy definition
+    #   - +message+ - message for the security policy definition
+    #   - +rule+ - rule for the security policy definition
+    #   - +type+ - type of the security policy 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_security_policy_definition(kapp_slug, name, body, headers=default_headers)
+      info("Updating Security Policy Definition \"#{name}\" on the \"#{kapp_slug}\" kapp.")
+      put("#{@api_url}/kapps/#{kapp_slug}/securityPolicyDefinitions/#{encode(name)}", body, headers)
+    end
+
+  end
+end

data/lib/kinetic_sdk/request_ce/lib/space.rb

@@ -0,0 +1,89 @@
+module KineticSdk
+  class RequestCe
+
+    # Add an attribute value to the space, or update an attribute if it already exists
+    #
+    # @param attribute_name [String] name of the attribute
+    # @param attribute_value [String] value of the attribute
+    # @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_attribute(attribute_name, attribute_value, headers=default_headers)
+      # first find the space
+      response = find_space({ "include" => "attributes"}, headers)
+      # hack to try a second time if space isn't found
+      if response.status == 404
+        sleep 2
+        response = find_space({ "include" => "attributes"}, headers)
+      end
+      space = response.content["space"]
+      attributes = space["attributes"]
+      # either add or update the attribute value
+      exists = false
+      attributes.each do |attribute|
+        info("Attribute: #{attribute.inspect}")
+        # if the attribute already exists, update it
+        if attribute["name"] == attribute_name
+          attribute["values"] = [ attribute_value ]
+          exists = true
+        end
+      end
+      # add the attribute if it didn't exist
+      attributes.push({
+        "name" => attribute_name,
+        "values" => [ attribute_value ]
+        }) unless exists
+
+      # set the updated attributes list
+      body = { "attributes" => attributes }
+      if exists
+        info("Updating attribute \"#{attribute_name}\" = \"#{attribute_value}\" in the \"#{space_slug}\" space.")
+      else
+        info("Adding attribute \"#{attribute_name}\" = \"#{attribute_value}\" to the \"#{space_slug}\" space.")
+      end
+      # Update the space
+      put("#{@api_url}/space", body, headers)
+    end
+
+    # Update a space
+    #
+    # @param body [Hash] properties for the Space
+    # @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(body={}, headers=default_headers)
+      info("Updating Space \"#{@space_slug}\"")
+      put("#{@api_url}/space", body, headers)
+    end
+
+    # Export a space
+    #
+    # @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(headers=default_headers)
+      info("Exporting Space \"#{@space_slug}\"")
+      get("#{@api_url}/space", { 'export' => true}, headers)
+    end
+
+    # Find 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(params={}, headers=default_headers)
+      info("Finding Space \"#{@space_slug}\"")
+      get("#{@api_url}/space", params, headers)
+    end
+
+    # Checks if the space exists
+    #
+    # @param slug [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 space_exists?(slug, params={}, headers=default_headers)
+      info("Checking if the \"#{slug}\" space exists")
+      response = get("#{@api_url}/spaces/#{slug}", params, headers)
+      response.status == 200
+    end
+
+  end
+end