sensu-settings 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54d0111bccce26545cf3c41ed61ec4fbfd550ce4
-  data.tar.gz: 5453d340333900902d7eab3fedae5438aa4b1718
+  metadata.gz: 1fdb6232d33121ec1fedbb3f3c8426371a89111b
+  data.tar.gz: 9b9d6896325f9f58982b25995d781cdcf5200fc8
 SHA512:
-  metadata.gz: 22eeed17690307c1335e314fa8a69ef727c4685a4a6a5c0e12ee2c6c5aa868f5481d5ec2dc678e64db99c0475751fa064e4d97c5e276b3afa37adc75f0503080
-  data.tar.gz: 7e89473c1889695fb5c238e73e0fc57026b4025291a7cc1932731b9e9485f3838687640011f23cb2b22b9cb85c67a4e9b33e19eb68e1a733b5ffa89e4dde9bb7
+  metadata.gz: 772d0f3421965e774bd7f2c33e56e081de4e1ba2592bbb7e8b4aad45b3d0601378b38cb76ae09148b3e7c6599d78efa58025113a2c9e925493d16c7487a86031
+  data.tar.gz: 501534272b7fc5c0a0c70634e1f6fdac842931fb4198b35cee587b120c61bd1d45b76e1ec59692af215f6bca5efd35dc58fb084b74ebbc370e6efcb2300aa82d

data/lib/sensu/settings/loader.rb

@@ -86,7 +86,7 @@ module Sensu
         if File.file?(file) && File.readable?(file)
           begin
             warning("loading config file", :file => file)
-            contents = IO.read(file)
+            contents = read_config_file(file)
             config = MultiJson.load(contents, :symbolize_keys => true)
             merged = deep_merge(@settings, config)
             unless @loaded_files.empty?
@@ -190,10 +190,32 @@ module Sensu
         @indifferent_access = true
       end
 
+      # Read a configuration file and force its encoding to 8-bit
+      # ASCII, ignoring invalid characters. If there is a UTF-8 BOM,
+      # it will be removed. Some JSON parsers force ASCII but do not
+      # remove the UTF-8 BOM if present, causing encoding conversion
+      # errors. This method is for consistency across MultiJson
+      # adapters and system platforms.
+      #
+      # @param [String] file path to read.
+      # @return [String] file contents.
+      def read_config_file(file)
+        contents = IO.read(file)
+        if contents.respond_to?(:force_encoding)
+          encoding = ::Encoding::ASCII_8BIT
+          contents = contents.force_encoding(encoding)
+          contents.sub!("\xEF\xBB\xBF".force_encoding(encoding), "")
+        else
+          contents.sub!(/^\357\273\277/, "")
+        end
+        contents
+      end
+
       # Deep merge two hashes.
       #
       # @param [Hash] hash_one to serve as base.
       # @param [Hash] hash_two to merge in.
+      # @return [Hash] deep merged hash.
       def deep_merge(hash_one, hash_two)
         merged = hash_one.dup
         hash_two.each do |key, value|

data/sensu-settings.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-settings"
-  spec.version       = "1.6.0"
+  spec.version       = "1.7.0"
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.summary       = "The Sensu settings library, loader and validator"

data/spec/assets/bom.json

@@ -0,0 +1,7 @@
+{
+	"client": {
+		"name": "bom",
+		"address": "utf-8",
+		"subscriptions": ["encoding"]
+	}
+}

data/spec/loader_spec.rb

@@ -97,6 +97,14 @@ describe "Sensu::Settings::Loader" do
     expect(messages).to include("ignoring config file")
   end
 
+  it "can load settings from a utf-8 encoded file with a bom" do
+    @loader.load_file(File.join(@assets_dir, "bom.json"))
+    warnings = @loader.warnings
+    failures = @loader.validate
+    expect(warnings.size).to eq(1)
+    expect(failures.size).to eq(0)
+  end
+
   it "can load settings from files in a directory" do
     @loader.load_directory(@config_dir)
     warnings = @loader.warnings

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-settings
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-22 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -109,6 +109,7 @@ files:
 - lib/sensu/settings/validators/transport.rb
 - sensu-settings.gemspec
 - spec/assets/app/config/sensu/app_http_endpoint.json
+- spec/assets/bom.json
 - spec/assets/conf.d/merger.json
 - spec/assets/conf.d/nested/file.json
 - spec/assets/config.json
@@ -144,6 +145,7 @@ specification_version: 4
 summary: The Sensu settings library, loader and validator
 test_files:
 - spec/assets/app/config/sensu/app_http_endpoint.json
+- spec/assets/bom.json
 - spec/assets/conf.d/merger.json
 - spec/assets/conf.d/nested/file.json
 - spec/assets/config.json