snapi 0.0.7 → 0.0.8

data/lib/snapi/argument.rb

@@ -94,6 +94,15 @@ module Snapi
       @attributes[:required] = bool
     end
 
+    # DSL Setter
+    # Description of the argument
+    #
+    # @param desc, String
+    def description(desc)
+      raise InvalidDescriptionError unless desc.class == String
+      @attributes[:description] = desc
+    end
+
     # DSL Setter
     # What type of value is this argument. This will impact the way in which
     # this argument value gets validated later on

data/lib/snapi/errors.rb

@@ -14,6 +14,7 @@ module Snapi
   InvalidArgumentAttributeError    = Class.new(StandardError)
   InvalidBooleanError              = Class.new(StandardError)
   InvalidCapabilityError           = Class.new(StandardError)
+  InvalidDescriptionError          = Class.new(StandardError)
   InvalidFormatError               = Class.new(StandardError)
   InvalidFunctionCallError         = Class.new(StandardError)
   InvalidFunctionNameError         = Class.new(StandardError)

data/lib/snapi/function.rb

@@ -60,25 +60,19 @@ module Snapi
     # @params args Hash
     # @returns Boolean
     def valid_args?(args={})
-      valid = false
-
       if arguments
         arguments.each do |name, argument|
-          if argument[:required]
-            return false if args[name] == nil
-          end
 
-          if argument[:default_value] && !args[name]
-            args[name] = argument[:default_value]
+          if argument[:default_value]
+            args[name] = args[name] || argument[:default_value]
           end
 
-          valid = argument.valid_input?(args[name])
+          return false if (argument[:required] && (args[name] == nil))
+          return false if (argument[:required] && !(argument.valid_input? args[name]))
         end
-      else
-        valid = true
       end
 
-      return valid
+      return true
     end
   end
 end

data/lib/snapi/validator.rb

@@ -1,3 +1,4 @@
+require 'json'
 module Snapi
 
   # Helpful module to check strings against named Regexp patterns which
@@ -53,6 +54,7 @@ module Snapi
         :ip                  => [IP_V4_REGEX, IP_V6_REGEX],
         :ipv6                => [IP_V6_REGEX],
         :ipv4                => [IP_V4_REGEX],
+        :json                => [JsonValidator],
         :mac                 => [MAC_REGEX],
         :snapi_function_name => [SNAPI_FUNCTION_NAME],
         :on_off              => [ON_OFF_REGEX],
@@ -120,4 +122,19 @@ module Snapi
     #
     URI_REGEX = /https?:\/\/[\S]+/
   end
+
+  # Provide an object to validate JSON with a =~ method that mirrors Regexp.=~.
+  # The existing validation code relies on the fact that Regexp.=~ will return
+  # the index for which the string matches the regex. We return 0 if the JSON
+  # is parsable, since the JSON string will always start at index 0.
+  class JsonValidator
+    def self.=~(obj)
+      begin
+        JSON.parse(obj)
+        0 
+      rescue
+        nil
+      end
+    end
+  end
 end

data/lib/snapi/version.rb

@@ -1,3 +1,3 @@
 module Snapi
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/argument_spec.rb

@@ -42,10 +42,15 @@ describe Snapi::Argument do
     subject.type(:string).should == :string
   end
 
+  it "can have a description set" do
+    subject.description("describe the argument").should == "describe the argument"
+  end
+
   it "can return a hash of its own options" do
     subject.attributes.keys.sort.should == []
   end
 
+
   describe "can validate types such as" do
     it ":boolean" do
       a = Snapi::Argument.new

data/spec/function_spec.rb

@@ -21,15 +21,49 @@ describe Snapi::Function do
 
   it "can validate a ruby hash of keys and values against its arguments" do
     subject.argument :argument do |arg|
-      arg.default_value  "test"
       arg.required true
       arg.type  :string
     end
 
-    subject.valid_args?({}).should == false
-    subject.valid_args?({:not_argument => "test value"}).should == false
-    subject.valid_args?({:argument => "test value"}).should == true
-    # ignores
-    subject.valid_args?({:argument => "test value", :not => :relevant}).should == true
+    subject.argument :optional_argument do |arg|
+      arg.type  :string
+    end
+
+    blank  = {}
+
+    # no relevant args
+    wrong1 = {
+      :not_argument => "test value"
+    }
+
+    # just the optional arg
+    wrong2 = {
+      :optional_argument => "test value"
+    }
+
+    # just required, missing non-required
+    valid1 = {
+      :argument => "test value"
+    }
+
+    # required + optional
+    valid2 = {
+      :argument          => "test value",
+      :optional_argument => "test value"
+    }
+
+    # ignores unexected key / values
+    valid3 = {
+      :argument => "test value",
+      :not      => :relevant
+    }
+
+
+    subject.valid_args?(blank).should  == false
+    subject.valid_args?(wrong1).should == false
+    subject.valid_args?(wrong2).should == false
+    subject.valid_args?(valid1).should == true
+    subject.valid_args?(valid2).should == true
+    subject.valid_args?(valid3).should == true
   end
 end

data/spec/validator_spec.rb

@@ -19,10 +19,15 @@ describe "Snapi::Validator" do
   end
 
   it "offers an array of regular expressions in exchange for a format type" do
-    test_format = Snapi::Validator.format_types.shuffle.first
-    v_reg = Snapi::Validator.validation_regex[test_format]
-    v_reg.class.should == Array
-    v_reg.first.class.should == Regexp
+    ip_reg = Snapi::Validator.validation_regex[:ip]
+    ip_reg.class.should                  == Array
+    ip_reg.first.class.should            == Regexp
+    ip_reg.first.respond_to?(:=~).should == true
+
+    json_reg = Snapi::Validator.validation_regex[:json]
+    json_reg.class.should                  == Array
+    json_reg.first.class.should            == Class
+    json_reg.first.respond_to?(:=~).should == true
   end
 
   it "will attempt to confirm if a string matches the specified regex" do
@@ -30,4 +35,12 @@ describe "Snapi::Validator" do
     Snapi::Validator.valid_input?( :ip, "192.168.10.256" ).should == false
     Snapi::Validator.valid_input?( :ip, "Jake the Dog"   ).should == false
   end
+
+  it "validates well-formed json" do
+    Snapi::Validator.valid_input?( :json, "{}" ).should            == true
+    Snapi::Validator.valid_input?( :json, "{'}" ).should           == false
+    Snapi::Validator.valid_input?( :json, "{\"asdf\": 3}" ).should == true
+    Snapi::Validator.valid_input?( :json, "{asdf: 3" ).should      == false
+    Snapi::Validator.valid_input?( :json, "[{},{}]" ).should       == true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapi
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec