floe-servicenow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a21bc46912ecef2e8cb54cbf34aa0722b374ce15887641e9ae693f7de18ef482
+  data.tar.gz: f8e3b7763f9bbf9bd49d330d60d8318afc440316ee4bffa98ca21074e98f6a51
+SHA512:
+  metadata.gz: 4c25ad353031d8d316b091ef47724365427db7f1198e0cc75a3eb439729c5defb6820a78ef5bebef1d2754a0ff8c6f3059d27364ac2ecccd8380795f7a470ba4
+  data.tar.gz: 7d9bbc25615f9de4ce93e1df3ce9291914001230cd094d965b793712eb472de17e8ac0aea55f493e89d65a355e769ef548a2d1484ce6491e8ff74b8496e8d1bd

data/.rubocop_local.yml

@@ -0,0 +1,5 @@
+AllCops:
+  Exclude:
+  - spec/schema.rb
+Rails:
+  Enabled: false

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-06-24
+
+Initial release
+
+### Added
+- Add ServiceNow Runner and Methods ([#2](https://github.com/ManageIQ/floe-servicenow/pull/2))
+- Add servicenow Table API ([#3](https://github.com/ManageIQ/floe-servicenow/pull/3))
+- Add ServiceNow CMDB API ([#6](https://github.com/ManageIQ/floe-servicenow/pull/6))
+- Add ServiceNow Incidents API ([#7](https://github.com/ManageIQ/floe-servicenow/pull/7))
+- Add ServiceNow ServiceCatalog API ([#8](https://github.com/ManageIQ/floe-servicenow/pull/8))
+- Add `ServiceNow::OAuth#token` to call `/oauth_token.do` and get an access_token ([#9](https://github.com/ManageIQ/floe-servicenow/pull/9))
+
+### Changed
+- Move API docs into a `docs/` subdirectory ([#10](https://github.com/ManageIQ/floe-servicenow/pull/10))
+
+
+[0.1.0]: https://github.com/ManageIQ/floe-servicenow/tree/v0.1.0

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,185 @@
+# Floe::ServiceNow
+
+ServiceNow API integration for [Floe](https://github.com/ManageIQ/floe) workflow engine. This gem provides a Runner and Methods classes that inherit from `Floe::BuiltinRunner::Runner` and `Floe::BuiltinRunner::Methods` to enable ServiceNow operations within Floe workflows.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'floe-servicenow'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install floe-servicenow
+```
+
+## API Classes
+- **[ServiceNow CMDB API](#cmdb-api-methods)**: Manage Configuration Items and relationships
+- **[ServiceNow Incident API](#incident-api-methods)**: Create, update, resolve, and query incidents
+- **[ServiceNow OAuth API](#oauth-api-methods)**: Authenticate and get an API token
+- **[ServiceNow Service Catalog API](#service-catalog-api-methods)**: Browse catalogs, manage cart, and submit orders
+- **[ServiceNow Table API](#table-api-methods)**: Manage ServiceNow Tables
+
+## Configuration
+
+### Authentication
+
+ServiceNow operations support two authentication methods:
+
+#### Basic Authentication
+```json
+{
+  "username": "your-username",
+  "password": "your-password"
+}
+```
+
+#### OAuth Bearer Token
+```json
+{
+  "access_token": "your-oauth-access-token",
+  "client_id": "your-client-id",
+  "client_secret": "your-client-secret",
+  "refresh_token": "your-refresh-token"
+}
+```
+
+**Security Note**: Never hardcode credentials in your workflow definitions. Use Floe's secrets management features.
+
+### OAuth Token Acquisition
+
+Use the `servicenow://oauth/token` endpoint to obtain OAuth access tokens. See the [OAuth API Methods](#oauth-api-methods) section for details.
+
+## Usage
+
+### Resource URI Format
+
+ServiceNow operations use the `servicenow://` URI scheme with API prefix:
+
+```
+servicenow://<api_name>/<method_name>
+```
+
+For example:
+- `servicenow://table/list_tables` - List all tables using Table API
+
+### Example Workflows
+
+Complete workflow examples demonstrating API usage can be found in the `examples/` directory:
+
+- **`examples/cmdb.asl`** - Demonstrates CMDB API operations including CI management and relationships
+- **`examples/incident.asl`** - Demonstrates Incident API operations (create, resolve, close)
+- **`examples/oauth.asl`** - Demonstrates OAuth authentication with both password and refresh_token grant types
+- **`examples/service_catalog.asl`** - Demonstrates Service Catalog API operations (browse catalogs, order items, track requests)
+- **`examples/table.asl`** - Demonstrates all Table API CRUD operations in a single workflow
+
+### Available Methods
+
+#### OAuth API Methods
+
+See [OAuth API documentation](docs/oauth.md) for authentication methods.
+
+| Method | Description |
+|--------|-------------|
+| [Get OAuth Token](docs/oauth.md#get-oauth-token) | Obtain OAuth access tokens using password or refresh_token grant types |
+
+#### Table API Methods
+
+See [Table API documentation](docs/table.md) for CRUD operations on ServiceNow tables.
+
+| Method | Description |
+|--------|-------------|
+| [List Tables](docs/table.md#list-tables) | List all sys_db_object tables |
+| [Query Records](docs/table.md#query-records) | Retrieve multiple records with filtering |
+| [Get Record](docs/table.md#get-record) | Retrieve a single record by sys_id |
+| [Create Record](docs/table.md#create-record) | Create a new record in a table |
+| [Update Record](docs/table.md#update-record) | Replace all fields of a record (PUT) |
+| [Patch Record](docs/table.md#patch-record) | Update specific fields of a record (PATCH) |
+| [Delete Record](docs/table.md#delete-record) | Delete a record from a table |
+
+#### CMDB API Methods
+
+See [CMDB API documentation](docs/cmdb.md) for Configuration Management Database operations.
+
+| Method | Description |
+|--------|-------------|
+| [Get Configuration Item](docs/cmdb.md#get-configuration-item) | Retrieve a single CI by sys_id |
+| [Query Configuration Items](docs/cmdb.md#query-configuration-items) | Query multiple CIs with filtering |
+| [Create Configuration Item](docs/cmdb.md#create-configuration-item) | Create a new CI |
+| [Update Configuration Item](docs/cmdb.md#update-configuration-item) | Update an existing CI |
+| [Delete Configuration Item](docs/cmdb.md#delete-configuration-item) | Delete a CI |
+| [Get CI Relationships](docs/cmdb.md#get-ci-relationships) | Retrieve CI and its relationships |
+| [Create CI Relationship](docs/cmdb.md#create-ci-relationship) | Create a relationship between two CIs |
+| [Get CI Classes](docs/cmdb.md#get-ci-classes) | Retrieve available CMDB CI classes |
+
+#### Incident API Methods
+
+See [Incident API documentation](docs/incident.md) for incident management operations.
+
+| Method | Description |
+|--------|-------------|
+| [Create Incident](docs/incident.md#create-incident) | Create a new incident |
+| [Get Incident](docs/incident.md#get-incident) | Retrieve a single incident by sys_id |
+| [Update Incident](docs/incident.md#update-incident) | Update an existing incident |
+| [Resolve Incident](docs/incident.md#resolve-incident) | Resolve an incident (state 6) |
+| [Close Incident](docs/incident.md#close-incident) | Close an incident (state 7) |
+| [Query Incidents](docs/incident.md#query-incidents) | Query multiple incidents with filtering |
+
+#### Service Catalog API Methods
+
+See [Service Catalog API documentation](docs/service_catalog.md) for catalog browsing and ordering operations.
+
+| Method | Description |
+|--------|-------------|
+| [Submit Catalog Item](docs/service_catalog.md#submit-catalog-item) | Submit a catalog item order directly |
+| [Get Request](docs/service_catalog.md#get-request) | Retrieve details of a service catalog request |
+| [Get Requested Item](docs/service_catalog.md#get-requested-item) | Retrieve summary of a requested catalog item |
+| [Get Catalogs](docs/service_catalog.md#get-catalogs) | Retrieve all available service catalogs |
+| [Get Catalog](docs/service_catalog.md#get-catalog) | Retrieve details of a specific catalog |
+| [Get Categories](docs/service_catalog.md#get-categories) | Retrieve all available catalog categories |
+| [Get Category](docs/service_catalog.md#get-category) | Retrieve details of a specific category |
+| [Get Items](docs/service_catalog.md#get-items) | Retrieve all available catalog items |
+| [Get Item](docs/service_catalog.md#get-item) | Retrieve details of a specific catalog item |
+| [Search Items](docs/service_catalog.md#search-items) | Search for catalog items by search term |
+| [Get Cart](docs/service_catalog.md#get-cart) | Retrieve current shopping cart contents |
+| [Add to Cart](docs/service_catalog.md#add-to-cart) | Add a catalog item to the shopping cart |
+| [Update Cart Item](docs/service_catalog.md#update-cart-item) | Update a catalog item in the shopping cart |
+| [Remove from Cart](docs/service_catalog.md#remove-from-cart) | Remove a catalog item from the shopping cart |
+| [Empty Cart](docs/service_catalog.md#empty-cart) | Remove all items from the shopping cart |
+| [Checkout Cart](docs/service_catalog.md#checkout-cart) | Checkout the shopping cart |
+| [Submit Order](docs/service_catalog.md#submit-order) | Submit the shopping cart as an order |
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ManageIQ/floe-servicenow.
+
+### Development Guidelines
+
+1. Follow existing code patterns from `Floe::BuiltinRunner`
+2. Add tests for all new methods
+3. Update documentation for new features
+4. Ensure all tests pass before submitting PR
+
+## License
+
+The gem is available as open source under the terms of the [Apache-2.0 License](https://opensource.org/licenses/Apache-2.0).
+
+## Related Projects
+
+- [Floe](https://github.com/ManageIQ/floe) - Workflow engine for Ruby
+- [ManageIQ](https://github.com/ManageIQ/manageiq) - Open-source management platform
+
+## Support
+
+For issues and questions:
+- GitHub Issues: https://github.com/ManageIQ/floe-servicenow/issues
+- ManageIQ Community: https://www.manageiq.org/community/

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task :default => :spec