floe-servicenow 0.1.0

data/lib/floe/servicenow/table.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Floe
+  module ServiceNow
+    class Table < Floe::ServiceNow::Methods
+      # List available tables
+      def self.list_tables(params, secrets, _context)
+        error = verify_credentials(secrets)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_instance_id(params)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        query_params = {}
+        query_params["sysparm_query"] = params["query"] if params["query"]
+        query_params["sysparm_limit"] = params["limit"] if params["limit"]
+        query_params["sysparm_offset"] = params["offset"] if params["offset"]
+        query_params["sysparm_fields"] = params["fields"] if params["fields"]
+
+        http_params = build_http_params(
+          "GET",
+          "/api/now/table/sys_db_object",
+          params,
+          secrets,
+          :query => query_params
+        )
+
+        http_request(http_params, {}, {})
+      end
+
+      # Query records from a table
+      def self.query_records(params, secrets, _context)
+        error = verify_credentials(secrets)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_instance_id(params)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "table_name")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        query_params = {}
+        query_params["sysparm_query"] = params["query"] if params["query"]
+        query_params["sysparm_limit"] = params["limit"] if params["limit"]
+        query_params["sysparm_offset"] = params["offset"] if params["offset"]
+        query_params["sysparm_fields"] = params["fields"] if params["fields"]
+        query_params["sysparm_display_value"] = params["display_value"] if params["display_value"]
+        query_params["sysparm_exclude_reference_link"] = params["exclude_reference_link"] if params["exclude_reference_link"]
+
+        http_params = build_http_params(
+          "GET",
+          "/api/now/table/#{params['table_name']}",
+          params,
+          secrets,
+          :query => query_params
+        )
+
+        http_request(http_params, {}, {})
+      end
+
+      # Get a single record by sys_id
+      def self.get_record(params, secrets, _context)
+        error = verify_credentials(secrets)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_instance_id(params)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "table_name")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "sys_id")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        query_params = {}
+        query_params["sysparm_fields"] = params["fields"] if params["fields"]
+        query_params["sysparm_display_value"] = params["display_value"] if params["display_value"]
+        query_params["sysparm_exclude_reference_link"] = params["exclude_reference_link"] if params["exclude_reference_link"]
+
+        http_params = build_http_params(
+          "GET",
+          "/api/now/table/#{params['table_name']}/#{params['sys_id']}",
+          params,
+          secrets,
+          :query => query_params
+        )
+
+        http_request(http_params, {}, {})
+      end
+
+      # Create a new record
+      def self.create_record(params, secrets, _context)
+        error = verify_credentials(secrets)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_instance_id(params)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "table_name")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "data")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        query_params = {}
+        query_params["sysparm_display_value"] = params["display_value"] if params["display_value"]
+        query_params["sysparm_exclude_reference_link"] = params["exclude_reference_link"] if params["exclude_reference_link"]
+        query_params["sysparm_input_display_value"] = params["input_display_value"] if params["input_display_value"]
+
+        http_params = build_http_params(
+          "POST",
+          "/api/now/table/#{params['table_name']}",
+          params,
+          secrets,
+          :query => query_params,
+          :body  => params["data"]
+        )
+
+        http_request(http_params, {}, {})
+      end
+
+      # Update a record (replace all fields)
+      def self.update_record(params, secrets, _context)
+        error = verify_credentials(secrets)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_instance_id(params)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "table_name")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "sys_id")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "data")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        query_params = {}
+        query_params["sysparm_display_value"] = params["display_value"] if params["display_value"]
+        query_params["sysparm_exclude_reference_link"] = params["exclude_reference_link"] if params["exclude_reference_link"]
+        query_params["sysparm_input_display_value"] = params["input_display_value"] if params["input_display_value"]
+
+        http_params = build_http_params(
+          "PUT",
+          "/api/now/table/#{params['table_name']}/#{params['sys_id']}",
+          params,
+          secrets,
+          :query => query_params,
+          :body  => params["data"]
+        )
+
+        http_request(http_params, {}, {})
+      end
+
+      # Patch a record (update specific fields)
+      def self.patch_record(params, secrets, _context)
+        error = verify_credentials(secrets)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_instance_id(params)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "table_name")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "sys_id")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "data")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        query_params = {}
+        query_params["sysparm_display_value"] = params["display_value"] if params["display_value"]
+        query_params["sysparm_exclude_reference_link"] = params["exclude_reference_link"] if params["exclude_reference_link"]
+        query_params["sysparm_input_display_value"] = params["input_display_value"] if params["input_display_value"]
+
+        http_params = build_http_params(
+          "PATCH",
+          "/api/now/table/#{params['table_name']}/#{params['sys_id']}",
+          params,
+          secrets,
+          :query => query_params,
+          :body  => params["data"]
+        )
+
+        http_request(http_params, {}, {})
+      end
+
+      # Delete a record
+      def self.delete_record(params, secrets, _context)
+        error = verify_credentials(secrets)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_instance_id(params)
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "table_name")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        error = verify_required_param(params, "sys_id")
+        return ServiceNow.error!({}, :cause => error) if error
+
+        http_params = build_http_params(
+          "DELETE",
+          "/api/now/table/#{params['table_name']}/#{params['sys_id']}",
+          params,
+          secrets
+        )
+
+        http_request(http_params, {}, {})
+      end
+    end
+  end
+end

data/lib/floe/servicenow/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Floe
+  module ServiceNow
+    VERSION = "0.1.0"
+  end
+end

data/lib/floe/servicenow.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "floe"
+require_relative "servicenow/version"
+require_relative "servicenow/methods"
+require_relative "servicenow/cmdb"
+require_relative "servicenow/incident"
+require_relative "servicenow/oauth"
+require_relative "servicenow/service_catalog"
+require_relative "servicenow/table"
+require_relative "servicenow/runner"
+
+module Floe
+  module ServiceNow
+    class Error < StandardError; end
+
+    class << self
+      def error!(runner_context = {}, cause:, error: "States.TaskFailed")
+        runner_context.merge!(
+          "running" => false,
+          "success" => false,
+          "output"  => {"Error" => error, "Cause" => cause}
+        )
+      end
+
+      def success!(runner_context = {}, output:)
+        runner_context.merge!(
+          "running" => false,
+          "success" => true,
+          "output"  => output
+        )
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: floe-servicenow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Grare
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: floe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: manageiq-style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ServiceNow API Integration for Floe
+email:
+- adam@grare.com
+executables:
+- floe-servicenow
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop_local.yml"
+- ".whitesource"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/cmdb.md
+- docs/incident.md
+- docs/oauth.md
+- docs/service_catalog.md
+- docs/table.md
+- examples/cmdb.asl
+- examples/create_server_ci.asl
+- examples/incident.asl
+- examples/oauth.asl
+- examples/service_catalog.asl
+- examples/table.asl
+- exe/floe-servicenow
+- lib/floe/service_now.rb
+- lib/floe/servicenow.rb
+- lib/floe/servicenow/cmdb.rb
+- lib/floe/servicenow/incident.rb
+- lib/floe/servicenow/methods.rb
+- lib/floe/servicenow/oauth.rb
+- lib/floe/servicenow/runner.rb
+- lib/floe/servicenow/service_catalog.rb
+- lib/floe/servicenow/table.rb
+- lib/floe/servicenow/version.rb
+homepage: https://github.com/ManageIQ/floe-servicenow
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/ManageIQ/floe-servicenow
+  source_code_uri: https://github.com/ManageIQ/floe-servicenow
+  changelog_uri: https://github.com/ManageIQ/floe-servicenow/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: ServiceNow API Integration for Floe
+test_files: []