snow_sync 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 291450da560ad042fd30195c1d5af042c4ff48b4
-  data.tar.gz: 1760e8efa915a578052e08cefc5873becf7a128d
+  metadata.gz: ea97a4f0bcc5c8db5ca1851c10b6fda3beb9d98b
+  data.tar.gz: 25b998519cde755b0b2816ad4177ef6d0d8dbbde
 SHA512:
-  metadata.gz: 351fe385067754cccb985ae275e12616e5727dc6753a8c602a75542df3e5cc3a4ae33ffe41f7f85d01e98c1b6940d0a81d31122ccb8bce8feb4d43267e92f5f3
-  data.tar.gz: 42568f36c2e279d3dd3cade31af8af0449a3f7483a3f03bfe5b0968ecc65de5d3f9202da209c60fda7536549f5d1d26c8a95c4863475ce96200d072686988a25
+  metadata.gz: 35a51a11647114eca0f2064ef24f11e554fd6f617410eca25173aabe055566be15c1403f0bd77511e210050f3f7bf6a5e1c2b22f58ce65fe4db1074b1da55aa0
+  data.tar.gz: b92030f7766b113e61f3674dab502b4eef4be1191947769278ac18f434d6ffcf28b49fdf1c3e1d37ad5ceb617ad829d2b90f666f9db99e805b39805176efbe2a

data/README.md

@@ -1,6 +1,6 @@
 # SnowSync
 
-[![Gem Version](https://img.shields.io/badge/gem-v2.0.7-brightgreen.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)
+[![Gem Version](https://img.shields.io/badge/gem-v3.0.1-brightgreen.svg)](https://rubygems.org/gems/snow_sync) [![Dependency Status](https://img.shields.io/badge/dependencies-up--to--date-blue.svg)](https://rubygems.org/gems/snow_sync) [![Downloads](https://img.shields.io/badge/downloads-4k%2B-lightgrey.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.
 
@@ -8,8 +8,16 @@ SnowSync syncronizes configured fields (scripts) for a ServiceNow instance local
 
 ## Installation
 
+```bash
+mkdir snow_sync
+```
+
+```bash
+cd snow_sync
+```
+
 ```ruby
-gem install --install-dir <path> snow_sync
+gem install --install-dir <path-to-the-snow_sync-dir> snow_sync
 ```
 
 ## Setup & Usage
@@ -19,10 +27,10 @@ gem install bundler
 ```
 
 ```bash
-cd <path>/gems/snow_sync-<version>
+cd <path-to-the-snow_sync-dir>/gems/snow_sync-<version>
 ```
 
-Create a Gemfile and add the following:
+Create a Gemfile and add the following Gem dependencies:
 
 ```ruby
 source 'https://rubygems.org'
@@ -47,7 +55,7 @@ cd /lib/snow_sync
 ```
 
 * Setup the configurations in the configs.yml
-* Only supports single table map configuration (multi coming soon...)
+* Now supports multi-table map configurations
 * Configuration path is the current working directory
 * Append /api/now/table/ to the base_url
 
@@ -64,8 +72,8 @@ guard -i
 cd <path>/gems/snow_sync-<version>
 ```
 
-* Create a test_configs.yml file
-* Create a test record in the instance (ex: a test script include)
+* 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

data/lib/snow_sync/configs.yml

@@ -13,3 +13,8 @@ table_map:
     table:
     sys_id:
     field:
+  scheduled_job:
+    name:
+    table:
+    sys_id:
+    field:

data/lib/snow_sync/sync_util.rb

@@ -128,34 +128,36 @@ module SnowSync
     end
 
     # Classifies a JS file by name
-    # @param [String] file JS file path
+    # @param [String] file JS file by name
+    # @return classified JS file by name
 
     def classify(file)
-      file = file.split("/").last.split(".").first.camelcase
+      file = file.split(".").first.camelcase
       file[0] = file[0].capitalize
       file
     end
 
     # Lookup returns the configured servicenow table hash
-    # @param [String] file JS file path
+    # @param [String] type Config table label
+    # @param [String] file JS file by name
     # @return configured servicenow table hash
 
-    def table_lookup(file)
+    def table_lookup(type, file)
       @configs["table_map"].select do |key, value|
-        if value["name"].eql?(classify(file))
+        if key.eql?(type) and value["name"].eql?(classify(file))
           return value
         end
       end
     end
 
     # Merges JS file changes with the encapsulated table response value
-    # @param [String] file JS file path
-    # @param [String] type Servicenow script type
+    # @param [String] type Config table label
+    # @param [String] file JS file by name
     # @param [Hash] table_hash Configured servicenow table hash
 
-    def merge_update(file, type, table_hash)
-      FileUtils.cd(file.split("/")[0..1].join("/"))
-      script_body = File.open(file.split("/").last).read
+    def merge_update(type, file, table_hash)
+      FileUtils.cd("sync" + "/" + type)
+      script_body = File.open(file).read
       @configs["table_map"][type]["mod"] = script_body
       FileUtils.cd("../..")
     end
@@ -169,14 +171,16 @@ module SnowSync
     end
 
     # 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|
-        file.downcase!
-        type = file.split("/")[1]
-        table_hash = table_lookup(file)
-        merge_update(file, type, table_hash)
+    # @param [Array] paths JS file paths
+
+    def push_modifications(paths)
+      paths.each do |path|
+        path.downcase!
+        path = path.split("/")
+        type = path[1]
+        file = path[2]
+        table_hash = table_lookup(type, file)
+        merge_update(type, file, table_hash)
         begin
           user = Base64.strict_decode64(@configs["creds"]["user"])
           pass = Base64.strict_decode64(@configs["creds"]["pass"])

data/lib/snow_sync/version.rb

@@ -1,3 +1,3 @@
 module SnowSync
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/spec/sync_util_spec.rb

@@ -111,7 +111,8 @@ describe "classify" do
 
   it "should convert snake_case string to CamelCase" do
     js_file_path = "sync/script_include/test_class.js"
-    cc = util.classify(js_file_path)
+    path = js_file_path.split("/")
+    cc = util.classify(path[2])
     expect(cc).to eq "TestClass"
   end
 
@@ -124,7 +125,7 @@ describe "table_lookup" do
   end 
 
   it "should return configured SN table" do
-    table_map = util.table_lookup("sync/script_include/test_class.js")
+    table_map = util.table_lookup("script_include", "test_class.js")
     expect(table_map.keys).to eq ["name", "table", "sys_id", "field"]
     expect(table_map["table"]).to eq "sys_script_include"
   end
@@ -139,20 +140,24 @@ describe "merge_update" do
 
   it "should merge script with the configs object" do
     FileUtils.mkdir_p("sync")
-    FileUtils.mkdir_p("sync/test_sub_dir")
+    FileUtils.mkdir_p("sync/script_include")
     json_resp = "var test = 'test'; \n" +
     "var testing = function(arg) { \n\tgs.print(arg) \n}; \n" +
     "testing('test');"
     name = "TestClass".snakecase
     path = proc do
-      FileUtils.cd("sync/test_sub_dir")
+      FileUtils.cd("sync/script_include")
     end
     util.create_file(name, json_resp, &path)
     FileUtils.cd("../..")
-    file = "sync/test_sub_dir/test_class.js"
-    table_map = util.table_lookup(file)
-    util.merge_update(file, "script_include", table_map)
+    file = "sync/script_include/test_class.js"
+    path = file.split("/")
+    type = path[1]
+    file = path[2]
+    table_map = util.table_lookup(type, file)
+    util.merge_update(type, file, table_map)
     expect(util.configs["table_map"]["script_include"]["mod"] != nil).to eq true
+    FileUtils.rm_rf("sync")
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snow_sync
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Andy Wallace
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-07 00:00:00.000000000 Z
+date: 2017-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler