sensu-json 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 605a98cc6ae77de3609a10fc69a586df9ed6538e
-  data.tar.gz: 0a7372801934d75dabe29e9bf3d76b7133838858
+  metadata.gz: d71ac5cd61fae3fa7d70aa641dbddb4cef5828d9
+  data.tar.gz: d63c376a21897c6b5a19c13143a6e0813b9157b6
 SHA512:
-  metadata.gz: 50518f61efe074a066bc1a7fd3fbdba8c349d962a301773ff797d02308ef56b9872be49e616ef33430e2cc844be950646bcd117286498017651e8b634230451d
-  data.tar.gz: 4be401bb0594582ac01af703987769cb2fb713f091b5f82cac6229c82b540e5bcfe42e2d81f1082c5e111acfa9254ebb9e7aed2ca741ec659a0ef215df57c2dc
+  metadata.gz: 7a8f27abd7e39f4a7bbf9fbc883bf5c548ff340fff9e959c8ad7179d6f95f64ce327b674ae8df8ee790231b85e092137364d873cda2d1649ba80b12512a62908
+  data.tar.gz: c077f7ef60e6ad64c569b0cc2e398337a9d2253cca4a6dcb8bd10ab394775b1d649ae0bfc7b8f1080089d99dc45f5d22e821ef11a48579dcfe4085a59b11aaab

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sensu/json/java.rb

@@ -2,11 +2,20 @@ require "json"
 
 module Sensu
   module JSON
+    # The Sensu JSON parser when running on JRuby.
     class Java
+      # Load (and parse) a JSON string. Sensu expects symbolized keys.
+      #
+      # @param string [String]
+      # @return [Object]
       def load(string)
         ::JSON.parse(string, :symbolize_names => true)
       end
 
+      # Dump (generate) a JSON string from a Ruby object.
+      #
+      # @param object [Object]
+      # @param options [Hash]
       def dump(object, options={})
         if options[:pretty]
           ::JSON.pretty_generate(object)

data/lib/sensu/json/oj.rb

@@ -2,13 +2,24 @@ gem "oj", "2.14.6"
 
 require "oj"
 
+Oj.default_options = {:mode => :compat}
+
 module Sensu
   module JSON
+    # The Sensu JSON parser when running on MRI.
     class Oj
+      # Load (and parse) a JSON string. Sensu expects symbolized keys.
+      #
+      # @param string [String]
+      # @return [Object]
       def load(string)
         ::Oj.load(string, :symbol_keys => true)
       end
 
+      # Dump (generate) a JSON string from a Ruby object.
+      #
+      # @param object [Object]
+      # @param options [Hash]
       def dump(object, options={})
         options.merge!(:indent => 2) if options[:pretty]
         ::Oj.dump(object, options)

data/lib/sensu/json/parse_error.rb

@@ -1,8 +1,14 @@
 module Sensu
   module JSON
+    # The Sensu JSON parser error abstraction.
     class ParseError < StandardError
       attr_reader :data, :cause
 
+      # Produce an encapsulating error for a parser error, maintaining
+      # the backtrace.
+      #
+      # @param original_error [Object]
+      # @param data [Object] (such as a JSON string).
       def self.build(original_error, data)
         new(original_error.message).tap do |error|
           error.instance_eval do

data/lib/sensu/json.rb

@@ -1,9 +1,17 @@
 require "sensu/json/parse_error"
 
+# Sensu, monitoring for today's infrastructure.
 module Sensu
+  # The Sensu JSON parser abstraction library.
   module JSON
+    # The Sensu JSON parser abstraction API.
     class << self
-      def setup
+      # Set up the JSON parser. This method must be called before any
+      # attempt to use the parser. The appropriate JSON parser will be
+      # loaded for the current platform.
+      #
+      # @return [Object] parser.
+      def setup!
         @@parser = case
         when RUBY_PLATFORM =~ /java/
           require "sensu/json/java"
@@ -14,6 +22,10 @@ module Sensu
         end
       end
 
+      # Load (and parse) a JSON string.
+      #
+      # @param string [String]
+      # @return [Object]
       def load(string)
         begin
           @@parser.load(string)
@@ -22,6 +34,10 @@ module Sensu
         end
       end
 
+      # Dump (generate) a JSON string from a Ruby object.
+      #
+      # @param object [Object]
+      # @param options [Hash]
       def dump(object, options={})
         @@parser.dump(object, options)
       end

data/sensu-json.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-json"
-  spec.version       = "0.0.1"
+  spec.version       = "1.0.0"
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.summary       = "The Sensu JSON parser abstraction library"

data/spec/json_spec.rb

@@ -0,0 +1,11 @@
+require "sensu/json"
+
+describe "Sensu::JSON" do
+  it "can load a parser for the current platform" do
+    Sensu::JSON.setup!
+    hash = Sensu::JSON.load('{"foo":"bar"}')
+    expect(hash).to eq({:foo => "bar"})
+    string = Sensu::JSON.dump({:baz => "qux"})
+    expect(string).to eq('{"baz":"qux"}')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Sean Porter
@@ -102,6 +102,7 @@ files:
 - lib/sensu/json/oj.rb
 - lib/sensu/json/parse_error.rb
 - sensu-json.gemspec
+- spec/json_spec.rb
 homepage: https://github.com/sensu/sensu-json
 licenses:
 - MIT
@@ -126,4 +127,5 @@ rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: The Sensu JSON parser abstraction library
-test_files: []
+test_files:
+- spec/json_spec.rb