snow_sync 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 767c4c759ea7399131d6ac18244530e04ce3adce
-  data.tar.gz: 9ae30f53d195d5b30be3af7178db1f7991d901b4
+  metadata.gz: a63114b35a309a5bdc3714391dc51d33ce00ea45
+  data.tar.gz: df6af2460173980d80e7ed4424d7decdde326339
 SHA512:
-  metadata.gz: 1ad5b750d3827b94f06cf70ea3c7fcf0d57be2ab14c1009574538dc6b375f44baeefb814281a87d93633e66f75f85402889be555370d1376656ddf43c5c2d864
-  data.tar.gz: fb8306796cc66077ea171110cbd39c687ab352a5474680d8a5ecea8e2ad6934693a44dde5a7351b8c922a1d392287f9c937e4d3dce1cb8a6b6b0b47821a1f5a8
+  metadata.gz: 0d090c298a497186d93292956a31eb63adcc8aca067cf7b5f40ee2657256b6d9a447ef2eaf3a7ce33d6ae48b6f43410b071c11dfe88d60cfee8bc9b06f46e6d4
+  data.tar.gz: 68c8c45c05758e7b5dfbb9ebd61e5d6150fd6ddb0021c41277718ee226f84cdadba0036f2bfe35007199fcd8d1a1a5da127ac0f8a4ee8d970ba7954e34e8056f

data/README.md

@@ -1,5 +1,7 @@
 # SnowSync
 
+[![Gem Version](https://img.shields.io/badge/gem-v2.0.4-blue.svg)](https://rubygems.org/gems/snow_sync) [![Dependency Status](https://img.shields.io/badge/dependencies-up--to--date-orange.svg)](https://rubygems.org/gems/snow_sync) [![Downloads](https://img.shields.io/badge/downloads-3k%2B-brightgreen.svg)](https://rubygems.org/gems/snow_sync)
+
 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.

data/lib/snow_sync/sync_util.rb

@@ -11,9 +11,8 @@ module SnowSync
 
     attr_accessor :cf, :configs, :logger
 
-    # creates a utility object
-    # sets the encapsulated data
-    # opts {string}: optional configuration
+    # Creates a utility object & sets the encapsulated config data
+    # @param [String] opts Optional configuration
 
     def initialize(opts = nil)
       opts.nil? ? @cf = "configs.yml" : @cf = "test_configs.yml"
@@ -21,9 +20,9 @@ module SnowSync
       @logger = Logger.new(STDERR)
     end
 
-    # creates a directory if no directory exists
-    # name {string}: required directory name
-    # &block {object}: optional directory path
+    # Creates a directory if no directory exists
+    # @param [String] name Required directory name
+    # @param [Object] &block Optional directory path
 
     def create_directory(name, &block)
       yield block if block_given?
@@ -33,11 +32,10 @@ module SnowSync
       end
     end
 
-    # creates a js file
-    # logs the file creation
-    # name {string}: required file name
-    # json {object}: required json object
-    # &block {object}: optional file path
+    # Creates a JS file & logs the file creation
+    # @param [String] name Required file name
+    # @param [Object] json Required json object
+    # @param [Object] &block Optional file path
 
     def create_file(name, json, &block)
       yield if block_given?
@@ -47,8 +45,8 @@ module SnowSync
       end
     end
 
-    # checks required configurations
-    # raises an exception when configs aren't found
+    # Checks required configurations
+    # @raise [ExceptionClass] Raises exception if configs are not found
 
     def check_required_configs
       missing_path = @configs["conf_path"].nil?
@@ -64,7 +62,7 @@ module SnowSync
       end    
     end
 
-    # encrypts config credentials based on previous sync
+    # Encrypts config credentials based on previous sync
 
     def encrypt_credentials
       previous_sync = File.directory?("sync")
@@ -83,7 +81,7 @@ module SnowSync
       end
     end
 
-    # requests, retrieves, sets up the js script file locally
+    # Requests, retrieves, sets up the JS script file locally
     
     def setup_sync_directories
       @configs["table_map"].each do |key, value|
@@ -112,8 +110,8 @@ module SnowSync
       end
     end
 
-    # classify's a local js file name
-    # file {string}: js file path
+    # Classifies a JS file by name
+    # @param [String] file JS file path
 
     def classify(file)
       file = file.split("/").last.split(".").first.camelcase
@@ -121,8 +119,9 @@ module SnowSync
       file
     end
 
-    # returns the configured SN table hash
-    # file {string}: js file path 
+    # Lookup returns the configured servicenow table hash
+    # @param [String] file JS file path
+    # @return configured servicenow table hash
 
     def table_lookup(file)
       @configs["table_map"].select do |key, value|
@@ -132,10 +131,9 @@ module SnowSync
       end
     end
 
-    # replaces the encapsulated table response value
-    # with the current js file updates
-    # file {string}: js file path
-    # table_hash {hash}: configured SN table hash
+    # Merges JS file changes with the encapsulated table response value
+    # @param [String] file JS file path
+    # @param [Hash] table_hash Configured servicenow table hash
 
     def merge_update(file, table_hash)
       FileUtils.cd(file.split("/")[0..1].join("/"))
@@ -144,9 +142,7 @@ module SnowSync
       FileUtils.cd("../..")
     end
 
-    # check required configurations
-    # encrypt configured credentials
-    # retrieve, set up the script file locally
+    # Completes a sync based on the configurations
 
     def start_sync
       check_required_configs
@@ -154,9 +150,8 @@ module SnowSync
       setup_sync_directories
     end
 
-    # merges all js file changes
-    # updates a SN instance with the changes
-    # files {array}: array of js file paths
+    # Merges all JS file changes & pushes to the configured servicenow instance
+    # @param [Array] files JS file paths
 
     def push_modifications(files)
       files.each do |file|

data/lib/snow_sync/version.rb

@@ -1,3 +1,3 @@
 module SnowSync
-  VERSION = "2.0.4"
+  VERSION = "2.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snow_sync
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors:
 - Andy Wallace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2017-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler