Add test and stub documentation for catalog object

Author: Kevin Paulisse

doc/dev/api/v1/objects/catalog.md

@@ -10,4 +10,25 @@ This object is the return value from the [`catalog`](/doc/dev/api/v1/calls/catal
 
 ## Methods
 
-## Exceptions
+#### `#builder` (String)
+
+#### `#compilation_dir` (String)
+
+#### `#error_message` (String)
+
+#### `#puppet_version` (String)
+
+#### `#resource(<Hash>)` (Object)
+
+#### `#resources` (Array&lt;Object&gt;)
+
+#### `#to_json` (String)
+
+#### `#valid?` (Boolean)
+
+## Other methods
+
+These methods are available for debugging or development purposes but are not guaranteed to remain consistent between versions:
+
+- `#to_h` (Hash): Returns hash representation of parsed JSON catalog
+- `#raw` (OctocatalogDiff::Catalog): Returns underlying internal catalog object

lib/octocatalog-diff/api/v1/catalog.rb

@@ -30,7 +30,7 @@ def builder
 
         # Public: Get the JSON for the catalog
         # @return [String] Catalog JSON
-        def catalog_json
+        def to_json
           @raw.catalog_json
         end
 
@@ -72,6 +72,12 @@ def resources
         def valid?
           @raw.valid?
         end
+
+        # Public: Return catalog as hash.
+        # @return [Hash] Catalog as hash
+        def to_h
+          @raw.catalog
+        end
       end
     end
   end

spec/octocatalog-diff/tests/api/v1/catalog_spec.rb

@@ -29,30 +29,50 @@
     describe '#builder' do
       it 'should wrap catalog method' do
         expect(@testobj.builder).to eq(@catalog.builder)
+        expect(@testobj.builder).to be_a_kind_of(String)
       end
     end
 
-    describe '#catalog_json' do
+    describe '#to_json' do
       it 'should wrap catalog method' do
-        expect(@testobj.catalog_json).to eq(@catalog.catalog_json)
+        expect(@testobj.to_json).to eq(@catalog.catalog_json)
+        expect(@testobj.to_json).to be_a_kind_of(String)
       end
     end
 
     describe '#compilation_dir' do
-      it 'should wrap catalog method' do
+      it 'should wrap catalog method if nil' do
         expect(@testobj.compilation_dir).to eq(@catalog.compilation_dir)
+        expect(@testobj.compilation_dir).to be_nil
+      end
+
+      it 'should wrap catalog method if not nil' do
+        expect(@catalog).to receive(:compilation_dir).and_return('foo')
+        expect(@testobj.compilation_dir).to eq('foo')
       end
     end
 
     describe '#error_message' do
-      it 'should wrap catalog method' do
+      it 'should wrap catalog method if nil' do
         expect(@testobj.error_message).to eq(@catalog.error_message)
+        expect(@testobj.error_message).to be_nil
+      end
+
+      it 'should wrap catalog method if not nil' do
+        expect(@catalog).to receive(:error_message).and_return('foo')
+        expect(@testobj.error_message).to eq('foo')
       end
     end
 
     describe '#puppet_version' do
-      it 'should wrap catalog method' do
+      it 'should wrap catalog method if nil' do
         expect(@testobj.puppet_version).to eq(@catalog.puppet_version)
+        expect(@testobj.puppet_version).to be_nil
+      end
+
+      it 'should wrap catalog method if not nil' do
+        expect(@catalog).to receive(:puppet_version).and_return('foo')
+        expect(@testobj.puppet_version).to eq('foo')
       end
     end
 
@@ -66,12 +86,21 @@
     describe '#resources' do
       it 'should wrap catalog method' do
         expect(@testobj.resources).to eq(@catalog.resources)
+        expect(@testobj.resources).to be_a_kind_of(Array)
       end
     end
 
     describe '#valid?' do
       it 'should wrap catalog method' do
         expect(@testobj.valid?).to eq(@catalog.valid?)
+        expect(@testobj.valid?).to be_a_kind_of(TrueClass)
+      end
+    end
+
+    describe '#to_h' do
+      it 'should wrap catalog method' do
+        expect(@testobj.to_h).to eq(@catalog.catalog)
+        expect(@testobj.to_h).to be_a_kind_of(Hash)
       end
     end
   end