apiculture 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef2587d9cd055ecd731cc11364e2660dcf95e9c
-  data.tar.gz: 9b4820367da19028395a2d9928e1520808d10fad
+  metadata.gz: fddefec311625b3874fbcf1f2359f17d9393ae03
+  data.tar.gz: 2006215622d1839c0316d1bd1c790b65b08e6fb5
 SHA512:
-  metadata.gz: cb167f833039971ee16271a0c48d911fd11eeb3aeddfc130bdd31773b63f60e670d4901f0b21cd6ad4357bd499e78243a58c5c07532b4a36685e56e5c0156216
-  data.tar.gz: 49b05ae437ad28f58d132534b2b7b07c5b768e60cc60e53b9ab5fd85c4fabccf2f9bcc49c8cb5c7867daa2de1b940a7f21d00debccd3c19b315781966f792f76
+  metadata.gz: 3933f460a2b5b2cd1ea3187d8b4023851efc82ad5b555b55decb0922751f198336998f59d16262ca522f2ef097c26e6978a063be122b842bf1ecd6977b7bacff
+  data.tar.gz: b8f2c0ed089a32b45b5edeb98aea9fe1110b07a92f3df5aa0497c24ccb61e602fcfc547d1b4a0d011a631ca5b871c3ab198569dee3ec04b6b78538392e1ce1fd

data/.travis.yml

@@ -1,5 +1,6 @@
 rvm:
 - 2.1.5
 - 2.2.2
+- 2.3.0
 sudo: false
 cache: bundler

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.15 ruby lib
+# stub: apiculture 0.0.16 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "apiculture"
-  s.version = "0.0.15"
+  s.version = "0.0.16"
 
   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-06-06"
+  s.date = "2016-09-27"
   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.2.2"
+  s.rubygems_version = "2.5.1"
   s.summary = "Sweet API sauce on top of Sintra"
 
   if s.respond_to? :specification_version then

data/lib/apiculture.rb

@@ -23,14 +23,14 @@ module Apiculture
   }
   
   AC_CHECK_TYPE_PROC = ->(param, value) {
-    value.is_a?(param.ruby_type) or raise ParameterTypeMismatch.new(param, value.class)
+    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, :ruby_type, :cast_proc_or_method)
+  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
   end
@@ -103,24 +103,24 @@ module Apiculture
   end
   
   # Add an optional parameter for the API call
-  def param(name, description, ruby_type, cast: IDENTITY_PROC)
+  def param(name, description, matchable, cast: IDENTITY_PROC)
     @apiculture_action_definition ||= ActionDefinition.new
-    @apiculture_action_definition.parameters << Parameter.new(name, description, required=false, ruby_type, cast)
+    @apiculture_action_definition.parameters << Parameter.new(name, description, required=false, matchable, cast)
   end
   
   # Add a requred parameter for the API call
-  def required_param(name, description, ruby_type, cast: IDENTITY_PROC)
+  def required_param(name, description, matchable, cast: IDENTITY_PROC)
     @apiculture_action_definition ||= ActionDefinition.new
-    @apiculture_action_definition.parameters << Parameter.new(name, description, required=true, ruby_type, cast)
+    @apiculture_action_definition.parameters << Parameter.new(name, description, required=true, matchable, cast)
   end
   
   # Describe a parameter that has to be included in the URL of the API call.
   # Route parameters are always required, and all the parameters specified
   # using +route_param+ should also be included in the path given for the route
   # definition
-  def route_param(name, description, ruby_type = String, cast: IDENTITY_PROC)
+  def route_param(name, description, matchable = String, cast: IDENTITY_PROC)
     @apiculture_action_definition ||= ActionDefinition.new
-    @apiculture_action_definition.route_parameters << RouteParameter.new(name, description, required=false, ruby_type, cast)
+    @apiculture_action_definition.route_parameters << RouteParameter.new(name, description, required=false, matchable, cast)
   end
   
   # Add a possible response, specifying the code and the JSON Response by example.
@@ -147,9 +147,9 @@ module Apiculture
   # Gets raised when a parameter is supplied and has a wrong type
   class ParameterTypeMismatch < ValidationError
     def initialize(ac_parameter, received_ruby_type)
-      parameter_name, expected_type = ac_parameter.name, ac_parameter.ruby_type
+      parameter_name, expected_type = ac_parameter.name, ac_parameter.matchable
       received_type = received_ruby_type
-      super "Received #{received_type}, expected #{expected_type} for :#{parameter_name}"
+      super "Received #{received_type}, expected #{expected_type.inspect} for :#{parameter_name}"
     end
   end
   

data/lib/apiculture/method_documentation.rb

@@ -132,7 +132,7 @@ class Apiculture::MethodDocumentation
         html.tr do
           html.td { html.tt(param.name.to_s) }
           html.td(param.required ? 'Yes' : 'No')
-          html.td(param.ruby_type.to_s)
+          html.td(param.matchable.inspect)
           html.td(param.description.to_s)
         end
       end

data/lib/apiculture/version.rb

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

data/spec/apiculture_spec.rb

@@ -149,7 +149,33 @@ describe "Apiculture" do
         post '/thing', {number: '123'}
       }.to raise_error('Received String, expected Integer for :number')
     end
-    
+
+    it 'supports an arbitrary object with === as a type specifier for a parameter' do
+      custom_matcher = Class.new do
+        def ===(value)
+          value == "Magic word"
+        end
+      end.new
+      
+      @app_class = Class.new(Sinatra::Base) do
+        settings.show_exceptions = false
+        settings.raise_errors = true
+        extend Apiculture
+      
+        required_param :pretty_please, "Only a magic word will do", custom_matcher
+        api_method :post, '/thing' do
+          'Ohai!'
+        end
+      end
+
+      post '/thing', {pretty_please: 'Magic word'}
+      expect(last_response).to be_ok
+
+      expect {
+        post '/thing', {pretty_please: 'not the magic word you are looking for'}
+      }.to raise_error(Apiculture::ParameterTypeMismatch)
+    end
+
     it 'suppresses parameters that are not defined in the action definition' do
       @app_class = Class.new(Sinatra::Base) do
         settings.show_exceptions = false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apiculture
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-09-27 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.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Sweet API sauce on top of Sintra