snow_sync 1.9.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78b94c4a7e29b91778922b49608a8eefbb3a1b0c
-  data.tar.gz: 3ab9be16455ffe12f67e8a0873d039ffbfa7a851
+  metadata.gz: 7426da92a88133f622c76eb1fd0a2ac246f67ba9
+  data.tar.gz: 3ef9f116203a9f13fc26c2e512f4a73b6af058a1
 SHA512:
-  metadata.gz: bee02c566b677ac61c404d48bb30a8dd8f91320d2b837f9cf909558d777d40cf5ebe3b3649344b22d66da874d1a9e993f588dc31b8a85279906ada897524e7f5
-  data.tar.gz: 67762effff9f2cbfa8a9153d53fd6de59bba69e7a2d8d60bcfea67f4ae6a5c5425c4002cd0bb0ddf07a78a7d4a0921b6e0671495407133da07aa2d16aa419733
+  metadata.gz: 0887c2e29d65bd236f512528cfcd6628377e543f9fb4662bfaed7d5b8319a543a117a53b4322bdc78166c2c37309837798eb47809fd023592009c1258eb09092
+  data.tar.gz: a89f50a0dc4463a229c85f76d894b416de3d1641fc9555459a6c54ca12ca9c19c1bee113d11e5e4ceb2555cb845468090264ab5b823288f381c2ceba957934f1

data/README.md

@@ -44,13 +44,17 @@ bundle install
 cd /lib/snow_sync
 ```
 
-* Setup the configs in the configs.yml
+* Setup the configurations in the configs.yml
+* Configurations path is <path>/gems/snow_sync-<version>/lib/snow_sync/
 * Append /api/now/table/ to the base_url
 
 ```bash
 guard -i
 ```
 
+Note: if the sync directory is deleted after a previous sync, reset the credential configs in the configs.yml so they can be re-encrypted
+
+
 ## Running the Tests
 
 ```bash
@@ -59,12 +63,16 @@ cd <path>/gems/snow_sync-<version>
 
 * Create a test_configs.yml file
 * Create a test record in the instance (ex: a test script include)
-* Setup the test configs
+* Setup the test configurations in the test_configs.yml
+* Configurations path is <path>/gems/snow_sync-<version>/
+* Append /api/now/table/ to the base_url
 
 ```ruby
 rspec spec/sync_util_spec.rb
 ```
 
+Note: if the sync directory is deleted after a previous sync, reset the credential configs in the test_configs.yml so they can be re-encrypted
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/snow_sync/sync_util.rb

@@ -9,14 +9,22 @@ module SnowSync
     require 'rest-client'
     require "yaml"
 
-    attr_accessor :configs, :logger
+    attr_accessor :cf, :configs, :logger
+
+    # creates utility object
+    # initializes encapsulated data
+    # opts {string}: optional configuration
 
     def initialize(opts = nil)
-      opts.nil? ? c = "configs.yml" : c = "test_configs.yml"
-      @configs = YAML::load_file(c)
+      opts.nil? ? @cf = "configs.yml" : @cf = "test_configs.yml"
+      @configs = YAML::load_file(@cf)
       @logger = Logger.new(STDERR)
     end
    
+    # creates directory if directory doesn't exist
+    # name {string}: required directory name
+    # &block {object}: optional directory path
+    
     def create_directory(name, &block)
       yield block if block_given?
       unless File.directory?(name)
@@ -25,6 +33,12 @@ module SnowSync
       end
     end
 
+    # creates a js file
+    # logs out the file created
+    # name {string}: required file name
+    # json {object}: required json object
+    # &block {object}: optional file path
+
     def create_file(name, json, &block)
       yield if block_given?
       File.open("#{name}.js", "w") do |f| 
@@ -33,24 +47,65 @@ module SnowSync
       end
     end
 
+    # checks required configurations
+    # raises an exception when required configs aren't found
+
     def check_required_configs
-      no_credentials = @configs["creds"].values.any? do |e|
+      conf_path = File.directory?(@configs["conf_path"])
+      missing_credentials = @configs["creds"].values.any? do |e|
         e.nil?
       end
       keys = @configs["table_map"].keys
       keys.each do |key|
-        no_table_map = @configs["table_map"][key].values.any? do |e|
+        # set as instance variable to reference outside block
+        @missing_table_map = @configs["table_map"][key].values.any? do |e|
           e.nil?
         end
-          if no_credentials or no_table_map
-            raise "EXCEPTION: Required configs missing in configs.yml. " \
-            "Please check your credentials and tables to sync."
-          else
-            return @configs
-          end
+      end
+      if missing_credentials or @missing_table_map or !conf_path
+        raise "EXCEPTION: Required configs missing in configs.yml. " \
+        "Please check the configuration path, credentials or table to sync."
+      else
+        @configs
+      end
+    end
+
+    # encrypts the configured credentials based on
+    # whether a previous sync setup has occurred
+
+    def encrypt_credentials
+      previous_sync = File.directory?("sync")
+      # sets up the configs object
+      configs_path = @configs["conf_path"] + @cf
+      configs = YAML::load_file(configs_path)
+      if previous_sync
+        # local configuration changes
+        configs = YAML::load_file(configs_path)
+        user = Base64.strict_decode64(@configs["creds"]["user"])
+        pass = Base64.strict_decode64(@configs["creds"]["pass"])
+        userb64 = Base64.strict_encode64(user)
+        passb64 = Base64.strict_encode64(pass)
+        configs["creds"]["user"] = userb64
+        configs["creds"]["pass"] = passb64
+        File.open(configs_path, 'w') { |f| YAML::dump(configs, f) }
+        # object state configuration changes
+        @configs["creds"]["user"] = userb64
+        @configs["creds"]["pass"] = passb64
+      else
+        # local configuration changes
+        userb64 = Base64.strict_encode64(@configs["creds"]["user"])
+        passb64 = Base64.strict_encode64(@configs["creds"]["pass"])
+        configs["creds"]["user"] = userb64
+        configs["creds"]["pass"] = passb64
+        File.open(configs_path, 'w') { |f| YAML::dump(configs, f) }
+        # object state configuration changes
+        @configs["creds"]["user"] = userb64
+        @configs["creds"]["pass"] = passb64
       end
     end
 
+    # requests, retrieves, sets up the js script file locally
+    
     def setup_sync_directories
       @configs["table_map"].each do |key, value|
         directory_name = "sync"
@@ -59,12 +114,12 @@ module SnowSync
         sub_directory_name = key
         create_directory(sub_directory_name, &path)
         begin
-          user = @configs["creds"]["user"]
-          pass = @configs["creds"]["pass"]
+          user = Base64.strict_decode64(@configs["creds"]["user"])
+          pass = Base64.strict_decode64(@configs["creds"]["pass"])
           response = RestClient.get(
           "#{@configs['base_url']}#{value["table"]}?sysparm_query=sys_id%3D" + 
           "#{value["sysid"]}%5Ename%3D#{value["name"]}",
-            {:authorization => "#{"Basic " + Base64.strict_encode64("#{user}:#{pass}")}", 
+            {:authorization => "#{"Basic " + Base64.strict_encode64("#{user}:#{pass}")}",
              :accept => "application/json"})
           path = proc { FileUtils.cd(sub_directory_name) }
           @configs[value["table"] + "_response"] = JSON.parse(response)["result"][0]
@@ -78,12 +133,18 @@ module SnowSync
       end
     end
 
+    # classify's a local js file name
+    # file {string}: js file path
+
     def classify(file)
       file = file.split("/").last.split(".").first.camelcase
       file[0] = file[0].capitalize
-      return file
+      file
     end
 
+    # returns the configured SN table hash
+    # file {string}: js file path 
+
     def table_lookup(file)
       @configs["table_map"].select do |key, value|
         if value["name"].eql?(classify(file))
@@ -92,6 +153,11 @@ module SnowSync
       end
     end
 
+    # replaces the encapsulated table reponse value
+    # with the current js file updates
+    # file {string}: js file path
+    # table_hash {hash}: configured SN table hash
+
     def merge_update(file, table_hash)
       FileUtils.cd(file.split("/")[0..1].join("/"))
       script_body = File.open(file.split("/").last).read
@@ -99,19 +165,29 @@ module SnowSync
       FileUtils.cd("../..")
     end
 
+    # start sync process
+    # check required configurations
+    # encrypt configured credentials
+    # retrieve and set up the script file locally
+
     def start_sync
       check_required_configs
+      encrypt_credentials
       setup_sync_directories
     end
 
+    # merges all js file changes
+    # updates SN instance with the js file changes
+    # files {array}: array of js file paths
+
     def push_modifications(files)
       files.each do |file|
         file.downcase!
         table_hash = table_lookup(file)
         merge_update(file, table_hash)
         begin
-          user = @configs["creds"]["user"]
-          pass = @configs["creds"]["pass"]
+          user = Base64.strict_decode64(@configs["creds"]["user"])
+          pass = Base64.strict_decode64(@configs["creds"]["pass"])
           request_body_map = { 
             table_hash["field"].to_sym => @configs[table_hash["table"] + "_response"] 
           }

data/lib/snow_sync/version.rb

@@ -1,3 +1,3 @@
 module SnowSync
-  VERSION = "1.9.4"
+  VERSION = "2.0.0"
 end

data/spec/spec_helper.rb

@@ -5,6 +5,9 @@ RSpec.configure do |config|
   require "json"
   require_relative "../lib/snow_sync/sync_util.rb"
 
+  @util = SnowSync::SyncUtil.new(opts = "test")
+  @util.encrypt_credentials
+
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end

data/spec/sync_util_spec.rb

@@ -1,20 +1,5 @@
 require "spec_helper"
 
-def setup_test_config
-  util.configs["base_url"] = "<base url>"
-  util.configs["creds"]["user"] = "<username>"
-  util.configs["creds"]["pass"] = "<password>"
-  util.configs["table_map"]["script_include"]["name"] = "<js class or script name>"
-  util.configs["table_map"]["script_include"]["table"] = "<table>"
-  util.configs["table_map"]["script_include"]["sysid"] = "<sys id>"
-  util.configs["table_map"]["script_include"]["field"] = "<field>" 
-end
-
-def setup_test_directory
-  FileUtils.mkdir_p("sync")
-  FileUtils.mkdir_p("sync/test_sub_dir")
-end
-
 ## --> unit tests
 describe "utility object" do
 
@@ -67,7 +52,8 @@ describe "create_file" do
   end
 
   it "should create a file" do
-    setup_test_directory
+    FileUtils.mkdir_p("sync")
+    FileUtils.mkdir_p("sync/test_sub_dir")
     json = { "property" => "value" }
     name = "TestClass".snakecase
     path = proc do
@@ -85,18 +71,29 @@ describe "check_required_configs" do
 
   let :util do
     SnowSync::SyncUtil.new(opts = "test")
-  end 
+  end
 
-  it "should raise an exception when there are no credentials" do
-    #user, no password
-    util.configs["creds"]["user"] = "test.user"
-    expect{util.check_required_configs}.to raise_error(/Please check your credentials and tables to sync/)
+  it "should raise an exception when there is no config path" do
+    util.configs["conf_path"] = "test/bad/path"
+    expect{util.check_required_configs}.to raise_error(/Please check the configuration path, credentials or table to sync/)
+  end
+
+  it "should raise an exception when there is no username" do
+    util.configs["creds"]["user"] = nil
+    expect{util.check_required_configs}.to raise_error(/Please check the configuration path, credentials or table to sync/)
+  end
+
+  it "should raise an exception when there is no password" do
+    util.configs["creds"]["pass"] = nil
+    expect{util.check_required_configs}.to raise_error(/Please check the configuration path, credentials or table to sync/)
   end
 
   it "should raise an exception when there are no tables mapped" do
-    #table, no attributes
-    util.configs["table_map"]["table"] = "test_table"
-    expect{util.check_required_configs}.to raise_error(/Please check your credentials and tables to sync/)
+    tables = util.configs["table_map"].keys
+    tables.each do |table|
+      util.configs["table_map"][table]["table"] = nil
+      expect{util.check_required_configs}.to raise_error(/Please check the configuration path, credentials or table to sync/)
+    end
   end
 
 end
@@ -122,7 +119,6 @@ describe "table_lookup" do
   end 
 
   it "should return configured SN table" do
-    setup_test_config
     table_map = util.table_lookup("sync/script_include/test_class.js")
     expect(table_map.keys).to eq ["name", "table", "sysid", "field"]
     expect(table_map["table"]).to eq "sys_script_include"
@@ -136,10 +132,9 @@ describe "merge_update" do
     SnowSync::SyncUtil.new(opts = "test")
   end
 
-  #merge_update
   it "should merge updated script with the configs object" do
-    setup_test_directory
-    setup_test_config
+    FileUtils.mkdir_p("sync")
+    FileUtils.mkdir_p("sync/test_sub_dir")
     json = { "property" => "value - with update" }
     name = "TestClass".snakecase
     path = proc do
@@ -163,7 +158,6 @@ describe "setup_sync_directories" do
   end
 
   it "should setup and synchronize field from the SN instance" do
-    setup_test_config
     util.setup_sync_directories
     file = File.open("sync/script_include/test_class.js")
     expect(file.is_a?(Object)).to eq true
@@ -179,7 +173,6 @@ describe "push_modifications" do
   end
 
   it "should push modifications to a configured instance" do
-    setup_test_config
     util.setup_sync_directories
     file = File.open("sync/script_include/test_class.js", "r+")
     lines = file.readlines
@@ -196,7 +189,6 @@ describe "push_modifications" do
     lines = file.readlines
     file.close
     expect(lines[0]).to eq "// test comment -\n"
-    FileUtils.rm_rf("sync")
   end
 
 end

metadata

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