apiculture 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fddefec311625b3874fbcf1f2359f17d9393ae03
-  data.tar.gz: 2006215622d1839c0316d1bd1c790b65b08e6fb5
+  metadata.gz: 917fb8bfc86e8bc1d1a9d02729434c6af8398c1b
+  data.tar.gz: 4c73cab2e1f0a8dfb2756175f1037f32a8336d0b
 SHA512:
-  metadata.gz: 3933f460a2b5b2cd1ea3187d8b4023851efc82ad5b555b55decb0922751f198336998f59d16262ca522f2ef097c26e6978a063be122b842bf1ecd6977b7bacff
-  data.tar.gz: b8f2c0ed089a32b45b5edeb98aea9fe1110b07a92f3df5aa0497c24ccb61e602fcfc547d1b4a0d011a631ca5b871c3ab198569dee3ec04b6b78538392e1ce1fd
+  metadata.gz: d0d6b8796a963cd7814bba03afc1904efeb23e901084eab438ce2af8a6379f5e7b5d1474f89cee53401e6d58d94c68be5290c8ed9677b169b9fd85df98cd4117
+  data.tar.gz: 33a2024a4918f561da343f6df0aa0876b1c458f5ffc9f02d1393284f64af5b5c06811cd65022cb26fa28d9407c332d52f048adcdafdbaa7f7bfc990c52a1eb58

data/apiculture.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: apiculture 0.0.16 ruby lib
+# stub: apiculture 0.0.17 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "apiculture"
-  s.version = "0.0.16"
+  s.version = "0.0.17"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov", "WeTransfer"]
-  s.date = "2016-09-27"
+  s.date = "2016-11-25"
   s.description = "A toolkit for building REST APIs on top of Sinatra"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "https://github.com/WeTransfer/apiculture"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
+  s.rubygems_version = "2.4.5.1"
   s.summary = "Sweet API sauce on top of Sintra"
 
   if s.respond_to? :specification_version then

data/lib/apiculture/version.rb

@@ -1,3 +1,3 @@
 module Apiculture
-  VERSION = '0.0.16'
-end
+  VERSION = '0.0.17'
+end

data/lib/apiculture.rb

@@ -26,10 +26,6 @@ module Apiculture
     param.matchable === value or raise ParameterTypeMismatch.new(param, value.class)
   }
   
-  AC_PERMIT_PROC = ->(maybe_strong_params, param_name) {
-    maybe_strong_params.permit(param_name) if maybe_strong_params.respond_to?(:permit)
-  }
-  
   class Parameter < Struct.new(:name, :description, :required, :matchable, :cast_proc_or_method)
     # Return Strings since Sinatra prefers string keys for params{}
     def name_as_string; name.to_s; end
@@ -154,7 +150,7 @@ module Apiculture
   end
   
   # Returns a Proc that calls the strong parameters to check the presence/types
-  def parametric_validator_proc_from(parametric_validators)
+  def parametric_validator_proc_from(parametric_validators, implicitly_defined_route_parameter_names)
     required_params = parametric_validators.select{|e| e.required }
     # Return a lambda that will be called with the Sinatra params
     parametric_validation_blk = ->{
@@ -171,14 +167,16 @@ module Apiculture
         
         # Ensure the typecast value adheres to the enforced Ruby type
         AC_CHECK_TYPE_PROC.call(param, params[param_name])
-        # ..permit it in the strong parameters if we support them
-        AC_PERMIT_PROC.call(params, param_name)
       end
       
       # The following only applies if the app does not use strong_parameters - 
       # this makes use of parameter mutability again to kill the parameters that are not permitted
-      # or mentioned in the API specification
-      unexpected_parameters = params.keys.map(&:to_s) - parametric_validators.map(&:name).map(&:to_s)
+      # or mentioned in the API specification. We need to keep the params which are specified in the
+      # route but not documented via Apiculture though
+      unexpected_parameters = Set.new(params.keys.map(&:to_s)) -
+        Set.new(parametric_validators.map(&:name).map(&:to_s)) -
+        Set.new(implicitly_defined_route_parameter_names.map(&:to_s))
+      
       unexpected_parameters.each do | parameter_to_discard |
         # TODO: raise or record a warning
         if env['rack.logger'].respond_to?(:warn)
@@ -243,23 +241,30 @@ module Apiculture
     
     # Pick out all the defined parameters and set up a block that can validate them
     # when the action is called. With that, set up the actual Sinatra method that will
-    # respond to the request.
-    parametric_checker_proc = parametric_validator_proc_from(action_def.parameters + action_def.route_parameters)
+    # respond to the request. We take care to preserve all the params that have NOT been documented
+    # using Apiculture but _were_ in fact specified in the actual path.
+    route_parameter_names = path.scan(/:([^:\/]+)/).flatten.map(&:to_sym)
+    parametric_checker_proc = parametric_validator_proc_from(action_def.parameters + action_def.route_parameters, route_parameter_names)
     public_send(http_verb, path, options) do |*matched_sinatra_route_params|
-      route_params = []
-      action_def.route_parameters.each_with_index do |route_param, index|
+      # Extract all the parameter names from the route path as given to the method
+      route_parameters = Hash[route_parameter_names.zip(matched_sinatra_route_params)]
+
+      # Apply route parameter checks, but only to params that were defined in the Apiculture action descriptor.
+      # All the other params have to go via bypass.
+      checked_route_parameters = action_def.route_parameters.select {|par| route_parameter_names.include?(par.name) }
+      checked_route_parameters.each do |route_param|
         # Apply the type cast and save it (since using our override we can mutate the params)
-        value_after_type_cast = AC_APPLY_TYPECAST_PROC.call(route_param.cast_proc_or_method, params[route_param.name])
-        route_params[index] = value_after_type_cast
-        
+        value_from_route_params = route_parameters.fetch(route_param.name)
+        value_after_type_cast = AC_APPLY_TYPECAST_PROC.call(route_param.cast_proc_or_method, value_from_route_params)
         # Ensure the typecast value adheres to the enforced Ruby type
-        AC_CHECK_TYPE_PROC.call(route_param, route_params[index])
-        # ..permit it in the strong parameters if we support them
-        AC_PERMIT_PROC.call(route_params, route_param.name)
+        AC_CHECK_TYPE_PROC.call(route_param, value_after_type_cast)
+        # ..and overwrite it in the route parameters hash
+        route_parameters[route_param.name] = value_after_type_cast
       end
+      # Execute parametric checks on all the OTHER params (forms etc.)
       instance_exec(&parametric_checker_proc)
       # Execute the original action via instance_exec, passing along the route args
-      instance_exec(*route_params, &blk)
+      instance_exec(*route_parameters.values, &blk)
     end
     
     # Reset for the subsequent action definition

data/spec/apiculture_spec.rb

@@ -191,7 +191,33 @@ describe "Apiculture" do
       post '/thing', {evil_ssh_injection: 'I am Homakov!'}
       expect(last_response).to be_ok
     end
-    
+
+    it 'allows route parameters that are not mentioned in the action definition, but are given in Sinatra path' do
+      @app_class = Class.new(Sinatra::Base) do
+        settings.show_exceptions = false
+        settings.raise_errors = true
+        extend Apiculture
+
+        api_method :post, '/api-thing/:id_of_thing' do |id|
+          raise 'id_of_thing must be passed' unless id == '123456'
+          raise "id_of_thing must be present in params, but they were #{params.inspect}" unless params.keys.include?('id_of_thing')
+          'All is well'
+        end
+
+        post '/vanilla-thing/:id_of_thing' do |id|
+          raise 'id_of_thing must be passed' unless id == '123456'
+          raise "id_of_thing must be present in params, but they were #{params.inspect}" unless params.keys.include?('id_of_thing')
+          'All is well'
+        end
+      end
+      
+      post '/vanilla-thing/123456'
+      expect(last_response).to be_ok
+
+      post '/api-thing/123456'
+      expect(last_response).to be_ok
+    end
+
     it 'raises when describing a route parameter that is not included in the path' do
       expect {
         Class.new(Sinatra::Base) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiculture
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -220,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Sweet API sauce on top of Sintra