geekier_factory 0.1.4 → 0.1.5

data/lib/geekier_factory/action.rb

@@ -1,6 +1,7 @@
 module GeekierFactory  
   class Action
     AttributesMissing = Class.new(Exception)
+    ValidationException = Class.new(Exception)
 
     def initialize(api, structure)
       @api = api
@@ -78,7 +79,8 @@ module GeekierFactory
       @api.api_connection
     end
 
-    def call(param_values)
+    def call(param_values = {})
+      validate_parameter_values(param_values)
       reqhash = request_hash(param_values)
       response = api_connection.run_request(reqhash[:verb], reqhash[:url], reqhash[:body], reqhash[:headers])
       handle_response!(response)
@@ -88,6 +90,46 @@ module GeekierFactory
       retry
     end
     
+    def validate_parameter_values(param_values)
+      errors = Hash.new { |hash,key|hash[key] = [] }
+
+      param_values.each do |k,v|
+        parameter = params.detect{|p| p['name'] == k.to_s}
+
+        errors[k] << "expected to be #{parameter['dataType']} (was #{p.class})" unless case parameter['dataType']
+                                                                                       when 'byte'
+                                                                                         true
+                                                                                       when 'string'
+                                                                                         v.is_a?(String)
+                                                                                       when 'boolean'
+                                                                                         v.is_a?(TrueClass) ||
+                                                                                         v.is_a?(FalseClass)
+                                                                                       when 'int'
+                                                                                         v.is_a?(Integer)
+                                                                                       when 'float'
+                                                                                         v.is_a?(Float)
+                                                                                       when 'double'
+                                                                                         v.is_a?(Double)
+                                                                                       when 'Date'
+                                                                                         (v.is_a?(Date) || Date.parse(v)) rescue false
+                                                                                       end
+
+        if parameter.has_key?('allowableValues')
+          vals = case parameter['allowableValues']['valueType']
+          when 'RANGE'
+            Range.new(parameter['allowableValues']['min'].to_i, parameter['allowableValues']['max'].to_i)
+          when 'LIST'
+            parameter['allowableValues']['values']
+          end
+          errors[k] << "expected to be one of #{vals}" unless vals.include?(v)
+        end
+      end
+
+      if errors.any?
+        raise ValidationException.new(errors.inspect)
+      end
+    end
+    
     def error_responses
       (@structure['errorResponses'] || []) + @api.error_responses
     end

data/lib/geekier_factory/version.rb

@@ -1,3 +1,3 @@
 module GeekierFactory
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/mock_definition.json

@@ -40,6 +40,19 @@
                             "name": "b2", 
                             "paramType": "body", 
                             "required": false
+                        },
+                        {
+                            "allowMultiple": false, 
+                            "dataType": "int", 
+                            "description": "third body parameter - integer", 
+                            "name": "b3", 
+                            "paramType": "body", 
+                            "required": false,
+                            "allowableValues": {
+                                "valueType": "RANGE",
+                                "min": 1,
+                                "max": 5
+                            }
                         },  
                         {
                             "allowMultiple": false, 
@@ -55,7 +68,11 @@
                             "description": "specify format", 
                             "name": "format", 
                             "paramType": "path", 
-                            "required": true
+                            "required": false,
+                            "allowableValues": {
+                                "valueType": "LIST",
+                                "values": ["json", "yaml"]
+                            }
                         }
                     ], 
                     "summary": "Call to test the API"

data/test/test_factory.rb

@@ -21,19 +21,19 @@ class TestFactory < Test::Unit::TestCase
   end
 
   test "action should have 4 parameters" do
-    assert_equal 6, @action.params.size
-    assert_equal ['q1', 'q2', 'b1', 'b2', 'action', 'format'], @action.params.map{ |p| p['name'] }
+    assert_equal 7, @action.params.size
+    assert_equal ['q1', 'q2', 'b1', 'b2', 'b3', 'action', 'format'], @action.params.map{ |p| p['name'] }
   end
 
   test "action should have 2 body and 2 query parameters and they should be different" do
-    assert_equal 2, @action.body_params.size
+    assert_equal 3, @action.body_params.size
     assert_equal 2, @action.url_params.size
     assert_not_equal @action.body_params, @action.url_params
   end
 
   test "calling the action should call the right url" do
     stub_http_request(:post, "localhost/api/v0.1/call.json").
-      with(:body => {:b1 => "body", :b2 => "test"}, :query => {:q1 => 'testing', :q2 => 'query'})
-    @action.call(:b1 => "body", :b2 => "test", :q1 => 'testing', :q2 => 'query', :action => 'call', :format => 'json')
+      with(:body => {:b1 => "body", :b3 => 3}, :query => {:q1 => 'testing', :q2 => 'query'})
+    @action.call(:b1 => "body", :b3 => 3, :q1 => 'testing', :q2 => 'query', :action => 'call', :format => 'json')
   end
 end

data/test/test_validation.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class TestValidation < Test::Unit::TestCase
+  setup do
+    @api = GeekierFactory.factorize(File.join(File.dirname(File.expand_path(__FILE__)), 'mock_definition.json'))
+    @action = @api.available_actions["test api"].first
+  end
+
+  test "should complain if all mandatory parameters are missing" do
+    assert_raise GeekierFactory::Action::AttributesMissing do
+      @action.call
+    end
+  end
+
+  test "should complain if any one mandatory parameter is missing" do
+    params = {:q1 => 'a', :b1 => 'b', :action => 'c'}
+    params.keys.each do |mp|
+      hsh = params.dup
+      hsh.delete(mp)
+      assert_raise GeekierFactory::Action::AttributesMissing do
+        @action.call hsh
+      end
+    end
+  end
+
+  test "should complain if any non-mandatory path parameter is missing (because I don't know yet what to do when those are missing)" do
+    params = {:q1 => 'a', :b1 => 'b', :action => 'c'}
+    assert_raise GeekierFactory::Action::AttributesMissing do
+      @action.call params
+    end
+  end
+  
+  test "should complain if a parameter is the wrong type" do
+    params = {:q1 => 'a', :b1 => 'b', :action => 'c'}
+    wrong_values = [{}, 4, true, nil, [], Object.new]
+    wrong_values.each do |wval|
+      assert_raise GeekierFactory::Action::ValidationException do
+        @action.call params.merge(:format => wval)
+      end
+    end
+  end
+  
+  test "should complain if a parameter is not included in a list" do
+    params = {:q1 => 'a', :b1 => 'b', :action => 'c'}
+    assert_raise GeekierFactory::Action::ValidationException do
+      @action.call params.merge(:format => 'xml')
+    end
+  end
+  
+  test "should complain if a parameter is not included in a range" do
+    params = {:q1 => 'a', :b1 => 'b', :action => 'c', :format => 'json'}
+    assert_raise GeekierFactory::Action::ValidationException do
+      @action.call params.merge(:b3 => 7)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geekier_factory
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,6 +160,7 @@ files:
 - test/helper.rb
 - test/mock_definition.json
 - test/test_factory.rb
+- test/test_validation.rb
 homepage: http://github.com/rulesio/geekier_factory_gem
 licenses: []
 post_install_message: