SnowSync

Gem Version Dependency Status Downloads

SnowSync is a file sync utility tool and API which provides a bridge for off platform ServiceNow development using an IDE or text editor locally.

SnowSync syncronizes configured fields (scripts) for a ServiceNow instance locally, then watches for file changes and syncs back changes to the corresponding record.

Installation

mkdir snow_sync

cd snow_sync

gem install --install-dir <path-to-the-snow_sync-dir> snow_sync

Setup & Usage

gem install bundler

cd <path-to-the-snow_sync-dir>/gems/snow_sync-<version>

Create a Gemfile and add the following Gem dependencies:

source 'https://rubygems.org'
gem 'facets', '~> 3.1.0'
gem 'guard', '~> 2.14.0'
gem 'guard-yield', '~> 0.1.0'
gem 'json', '>= 1.8.3', '~> 1.8.0'
gem 'libnotify', '~> 0.9.1'
gem 'rake', '~> 10.0.0'
gem 'rest-client', '~> 2.0.0'
gem 'rspec', '~> 3.5.0'
gem 'thor', '0.19.1'

bundle install

cd /lib/snow_sync
  • Setup the configurations in the configs.yml
  • Now supports multi-table map configurations
  • Configuration path is the current working directory
  • Append /api/now/table/ to the base_url
guard -i

Note: if the sync directory is deleted after a successful sync, reset the credential configs in the configs.yml so they can be re-encrypted on the next sync

Running the Tests

cd <path-to-the-snow_sync-dir>/gems/snow_sync-<version>
  • Integration tests use a test record in the instance (e.g. a script include)
  • Unit tests are all stubbed out
  • Setup the test configurations in the test_configs.yml
  • Configuration path is the current working directory
  • Append /api/now/table/ to the base_url
rspec spec/sync_util_spec.rb

Note: if the sync directory is deleted after a successful sync, reset the credential configs in the test_configs.yml so they can be re-encrypted on the next sync

License

The gem is available as open source under the terms of the MIT License.