snow_sync 2.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 905983c32873b5a04a55c0b4e803bea4b000983d
-  data.tar.gz: 6d9b92b9565aab913b6ef1425558a409f12ee3af
+  metadata.gz: 767c4c759ea7399131d6ac18244530e04ce3adce
+  data.tar.gz: 9ae30f53d195d5b30be3af7178db1f7991d901b4
 SHA512:
-  metadata.gz: 5a05d068e3a24facb5a9141fa2c84bf3dcec69e8544d6ca62212e033f65faf40e555d9a75d5597410f06e494431a6aab44d6ffc03aefbd9ecb242509c632f760
-  data.tar.gz: fc220ed96e5b09974f6fd28834f5f01028f745a09ac5f3a0655e1cc58cae7b66907b7eead93df3033b3e0c3041f283863ac5bdda55032d1e1e8a688d35783ed3
+  metadata.gz: 1ad5b750d3827b94f06cf70ea3c7fcf0d57be2ab14c1009574538dc6b375f44baeefb814281a87d93633e66f75f85402889be555370d1376656ddf43c5c2d864
+  data.tar.gz: fb8306796cc66077ea171110cbd39c687ab352a5474680d8a5ecea8e2ad6934693a44dde5a7351b8c922a1d392287f9c937e4d3dce1cb8a6b6b0b47821a1f5a8

data/README.md

@@ -45,6 +45,7 @@ cd /lib/snow_sync
 ```
 
 * Setup the configurations in the configs.yml
+* Only supports single table map configuration (multi coming soon...)
 * Configuration path is the current working directory
 * Append /api/now/table/ to the base_url
 
@@ -52,7 +53,7 @@ cd /lib/snow_sync
 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
+**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
@@ -71,7 +72,7 @@ cd <path>/gems/snow_sync-<version>
 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
+**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
 

data/lib/snow_sync/sync_util.rb

@@ -11,8 +11,8 @@ module SnowSync
 
     attr_accessor :cf, :configs, :logger
 
-    # creates utility object
-    # initializes encapsulated data
+    # creates a utility object
+    # sets the encapsulated data
     # opts {string}: optional configuration
 
     def initialize(opts = nil)
@@ -20,11 +20,11 @@ module SnowSync
       @configs = YAML::load_file(@cf)
       @logger = Logger.new(STDERR)
     end
-   
-    # creates directory if directory doesn't exist
+
+    # creates a directory if no directory exists
     # name {string}: required directory name
     # &block {object}: optional directory path
-    
+
     def create_directory(name, &block)
       yield block if block_given?
       unless File.directory?(name)
@@ -34,7 +34,7 @@ module SnowSync
     end
 
     # creates a js file
-    # logs out the file created
+    # logs the file creation
     # name {string}: required file name
     # json {object}: required json object
     # &block {object}: optional file path
@@ -48,50 +48,29 @@ module SnowSync
     end
 
     # checks required configurations
-    # raises an exception when required configs aren't found
+    # raises an exception when configs aren't found
 
     def check_required_configs
-      conf_path = File.directory?(@configs["conf_path"])
-      missing_credentials = @configs["creds"].values.any? do |e|
-        e.nil?
-      end
+      missing_path = @configs["conf_path"].nil?
+      missing_url = @configs["base_url"].nil?
+      missing_creds = @configs["creds"].values.any? { |val| val.nil? }
       keys = @configs["table_map"].keys
       keys.each do |key|
-        # set as instance variable to reference outside block
-        @missing_table_map = @configs["table_map"][key].values.any? do |e|
-          e.nil?
+        missing_map = @configs["table_map"][key].values.any? { |val| val.nil? }
+        if missing_path or missing_url or missing_creds or missing_map
+          raise "EXCEPTION: Required configs missing in configs.yml. " \
+          "Check the configuration path, base url, credentials or table to sync."
         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    
     end
 
-    # encrypts the configured credentials based on
-    # whether a previous sync setup has occurred
+    # encrypts config credentials based on previous sync
 
     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
+      if !previous_sync
+        configs_path = @configs["conf_path"] + @cf
         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"])
@@ -100,7 +79,7 @@ module SnowSync
         File.open(configs_path, 'w') { |f| YAML::dump(configs, f) }
         # object state configuration changes
         @configs["creds"]["user"] = userb64
-        @configs["creds"]["pass"] = passb64
+	@configs["creds"]["pass"] = passb64
       end
     end
 
@@ -153,7 +132,7 @@ module SnowSync
       end
     end
 
-    # replaces the encapsulated table reponse value
+    # replaces the encapsulated table response value
     # with the current js file updates
     # file {string}: js file path
     # table_hash {hash}: configured SN table hash
@@ -165,10 +144,9 @@ module SnowSync
       FileUtils.cd("../..")
     end
 
-    # start sync process
     # check required configurations
     # encrypt configured credentials
-    # retrieve and set up the script file locally
+    # retrieve, set up the script file locally
 
     def start_sync
       check_required_configs
@@ -177,7 +155,7 @@ module SnowSync
     end
 
     # merges all js file changes
-    # updates SN instance with the js file changes
+    # updates a SN instance with the changes
     # files {array}: array of js file paths
 
     def push_modifications(files)

data/lib/snow_sync/version.rb

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

data/spec/sync_util_spec.rb

@@ -74,25 +74,30 @@ describe "check_required_configs" do
   end
 
   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/)
+    util.configs["conf_path"] = nil
+    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
+  end
+
+  it "should raise an exception when there is no base url" do
+    util.configs["base_url"] = nil
+    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, 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/)
+    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, 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/)
+    expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
   end
 
   it "should raise an exception when there are no tables mapped" do
     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/)
+      expect{util.check_required_configs}.to raise_error(/Check the configuration path, base url, credentials or table to sync/)
     end
   end
 

metadata

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