apipie-bindings 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e2b6c74e6f5eabc3b2c279de947f3d8249fd978
-  data.tar.gz: bac12a5d7f2d0c2bf25ca97fc1430c5767dd3aba
+  metadata.gz: ff423fb9cfff64a08d97f4a3709b25e03efa1289
+  data.tar.gz: 589750c97d73e14a76480b7f286652706fcb2871
 SHA512:
-  metadata.gz: 6c6cc3e9a3bbacc815c2d775bc72face007584478f80e245102edd325617699e48963632471be919d5a81d44d3b422bfcbc002f92a4129134c82711121ed64e5
-  data.tar.gz: 4149592d5f3f8424080881f0cd124caf2d3bbe506c6e13daf986eca4f362e2746f148e575400ed8c2b268917b454f0590b2eca0c9aa26a7494587d67a6c4ce44
+  metadata.gz: d98b130b8d4bfc3d0f8b8b55da47491ab310d0a3bc5a9bfc6486863d02153bcff05656584225a164e7b746b4f32dcf998fb5f38faf6e1d0faae3884878abd7f9
+  data.tar.gz: eefe52e4281fde2e644eb2be132d2f4045d9803966f8ab4016a8f2fb1b9adb158d75ac0e29c9e35ea24e803870ee694f433c16570726aa4add3f23b2fd075522

data/doc/release_notes.md

@@ -1,6 +1,9 @@
 Release notes
 =============
 
+### 0.0.10 (2014-09-18)
+* apipie-bindings should enforce required params, BZ 1116803 ([#6820](http://projects.theforeman.org/issues/6820))
+
 ### 0.0.9 (2014-08-29)
 * Fixes RHBZ#1134954 - Log API errors that are re-risen with debug verbosity
 * Add apidoc_cache_base_dir option to move all caches to another dir

data/lib/apipie_bindings/action.rb

@@ -1,3 +1,5 @@
+require 'apipie_bindings/utilities'
+
 module ApipieBindings
 
   class Action
@@ -56,16 +58,34 @@ module ApipieBindings
     end
 
     def validate!(params)
-      # return unless params.is_a?(Hash)
+      missing_params = missing_params(api_params_tree { |par| par.required? }, params_tree(params))
+      raise ApipieBindings::MissingArgumentsError.new(missing_params) unless missing_params.empty?
+    end
+
+    def api_params_tree(&block)
+      ApipieBindings::Utilities.params_hash_tree(self.params, &block)
+    end
 
-      # invalid_keys = params.keys.map(&:to_s) - (rules.is_a?(Hash) ? rules.keys : rules)
-      # raise ArgumentError, "Invalid keys: #{invalid_keys.join(", ")}" unless invalid_keys.empty?
+    def params_tree(params)
+      params.inject([]) do |tree, (key, val)|
+        subtree = val.is_a?(Hash) ? { key.to_s => params_tree(val) } : key.to_s
+        tree << subtree
+        tree
+      end
+    end
 
-      # if rules.is_a? Hash
-      #   rules.each do |key, sub_keys|
-      #     validate_params!(params[key], sub_keys) if params[key]
-      #   end
-      # end
+    def missing_params(master, slave)
+      missing = []
+      master.each do |required_param|
+        if required_param.is_a?(Hash)
+          key = required_param.keys.first
+          slave_hash = slave.select { |p| p.is_a?(Hash) && p[key] }
+          missing << missing_params(required_param[key], slave_hash.first ? slave_hash.first[key] : [])
+        else
+          missing << required_param unless slave.include?(required_param)
+        end
+      end
+      missing.flatten.sort
     end
 
     def to_s

data/lib/apipie_bindings/api.rb

@@ -148,7 +148,7 @@ module ApipieBindings
       resource = resource(resource_name)
       action = resource.action(action_name)
       route = action.find_route(params)
-      #action.validate(params)
+      action.validate!(params)
       options[:fake_response] = find_match(fake_responses, resource_name, action_name, params) || action.examples.first if dry_run?
       return http_call(
         route.method,

data/lib/apipie_bindings/exceptions.rb

@@ -3,4 +3,13 @@ module ApipieBindings
   class ConfigurationError < StandardError; end
   class DocLoadingError < StandardError; end
 
+  class MissingArgumentsError < StandardError
+    attr_reader :params
+
+    def initialize(params)
+      @params = params
+    end
+
+  end
+
 end

data/lib/apipie_bindings/param.rb

@@ -1,3 +1,5 @@
+require 'apipie_bindings/utilities'
+
 module ApipieBindings
 
   class Param
@@ -11,10 +13,14 @@ module ApipieBindings
       @params = params.map { |p| ApipieBindings::Param.new(p) }
       @expected_type = param[:expected_type].to_sym
       @description = param[:description].gsub(/<\/?[^>]+?>/, "")
-      @required = param[:required]
+      @required = param[:required] || @params.inject(false) { |req, par| req ||= par.required? }
       @validator = param[:validator]
     end
 
+    def tree(&block)
+      ApipieBindings::Utilities.params_hash_tree(@params, &block)
+    end
+
     def required?
       @required
     end

data/lib/apipie_bindings/utilities.rb

@@ -0,0 +1,18 @@
+module ApipieBindings
+
+  module Utilities
+
+    def self.params_hash_tree(params_hash, &block)
+      block ||= lambda { |_| true }
+      params_hash.inject([]) do |tree, par|
+        if block.call(par)
+          subtree = par.expected_type == :hash ? { par.name => par.tree(&block) } : par.name
+          tree << subtree
+        end
+        tree
+      end
+    end
+
+  end
+
+end

data/lib/apipie_bindings/version.rb

@@ -1,5 +1,5 @@
 module ApipieBindings
   def self.version
-    @version ||= Gem::Version.new '0.0.9'
+    @version ||= Gem::Version.new '0.0.10'
   end
 end

data/test/unit/action_test.rb

@@ -41,8 +41,20 @@ describe ApipieBindings::Action do
     # incuded params in alphanumeric order.
 
 
-  it "should validate the params" do
-    resource.action(:create).validate!({ :architecture => { :name => 'i386' } })
+  it "should validate incorrect params" do
+    proc do
+      resource.action(:create).validate!({ :architecture => { :foo => "foo" } })
+    end.must_raise(ApipieBindings::MissingArgumentsError)
+
+    proc do
+      # completely different sub-hash; should still fail
+      resource.action(:create).validate!({ :organization => { :name => "acme" } })
+    end.must_raise(ApipieBindings::MissingArgumentsError)
+  end
+
+  it "should accept correct params" do
+    resource.action(:create).validate!({:architecture => { :name => 'i386' } })
+    resource.action(:create_unnested).validate!(:name => "i386")
   end
 
   it "should have name visible in puts" do

data/test/unit/data/architecture.json

@@ -145,6 +145,44 @@
                             }
                         ],
                         "see": []
+                    },
+                    {
+                        "apis": [
+                            {
+                                "api_url": "/api/architectures",
+                                "http_method": "POST",
+                                "short_description": "create an architecture."
+                            }
+                        ],
+                        "doc_url": "/apidoc/v2/architectures/create",
+                        "errors": [],
+                        "examples" : [
+                            "same as nested create"
+                        ],
+                        "formats": null,
+                        "full_description": "",
+                        "name": "create_unnested",
+                        "params":[
+                            {
+                                "allow_nil": false,
+                                "description": "",
+                                "expected_type": "string",
+                                "full_name": "architecture[name]",
+                                "name": "name",
+                                "required": true,
+                                "validator": "Must be String"
+                            },
+                            {
+                                "allow_nil": false,
+                                "description": "\n<p>Operatingsystem ID\u2019s</p>\n",
+                                "expected_type": "array",
+                                "full_name": "architecture[operatingsystem_ids]",
+                                "name": "operatingsystem_ids",
+                                "required": false,
+                                "validator": "Must be Array"
+                            }
+                        ],
+                        "see": []
                     }
                 ]
             }

data/test/unit/resource_test.rb

@@ -6,7 +6,7 @@ describe ApipieBindings::Resource do
     :apidoc_cache_name => 'architecture'}).resource(:architectures) }
 
   it "should list actions" do
-    resource.actions.map(&:name).must_equal [:index, :show, :create]
+    resource.actions.map(&:name).must_equal [:index, :show, :create, :create_unnested]
   end
 
   it "should test action existence" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-bindings
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Martin Bačovský
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -214,6 +214,7 @@ files:
 - lib/apipie_bindings/resource.rb
 - lib/apipie_bindings/rest_client_oauth.rb
 - lib/apipie_bindings/route.rb
+- lib/apipie_bindings/utilities.rb
 - lib/apipie_bindings/version.rb
 - test/unit/action_test.rb
 - test/unit/api_test.rb