Merge pull request #831 from cantino/website_agent_jsonpath_validation

add a validation that warns the user if they have not provided a path when using JSONPath

app/models/agents/website_agent.rb

@@ -151,6 +151,15 @@ def validate_options
       end
 
       validate_web_request_options!
+      validate_extract_options!
+    end
+
+    def validate_extract_options!
+      if extraction_type == "json" && interpolated['extract'].is_a?(Hash)
+        unless interpolated['extract'].all? { |name, details| details.is_a?(Hash) && details['path'].present? }
+          errors.add(:base, 'When type is json, all extractions must have a path attribute.')
+        end
+      end
     end
 
     def check

spec/models/agents/website_agent_spec.rb

@@ -75,6 +75,23 @@
         @checker.options['force_encoding'] = 'UTF-42'
         expect(@checker).not_to be_valid
       end
+
+      context "in 'json' type" do
+        it "should ensure that all extractions have a 'path'" do
+          @checker.options['type'] = 'json'
+          @checker.options['extract'] = {
+            'url' => { 'foo' => 'bar' },
+          }
+          expect(@checker).to_not be_valid
+          expect(@checker.errors_on(:base)).to include("When type is json, all extractions must have a path attribute.")
+
+          @checker.options['type'] = 'json'
+          @checker.options['extract'] = {
+            'url' => { 'path' => 'bar' },
+          }
+          expect(@checker).to be_valid
+        end
+      end
     end
 
     describe "#check" do
@@ -179,7 +196,6 @@
 
         checker.check
         event = Event.last
-        puts event.payload
         expect(event.payload['version']).to eq(2)
       end
     end