sinatra-param 0.1.1 → 0.1.2

data/{lib/example → example}/app.rb

@@ -1,7 +1,7 @@
 require 'sinatra/base'
 require 'json'
 
-require_relative '../sinatra/param'
+require_relative '../lib/sinatra/param'
 
 class App < Sinatra::Base
   helpers Sinatra::Param
@@ -9,32 +9,32 @@ class App < Sinatra::Base
   before do
     content_type :json
   end
-  
+
   # GET /messages
   # GET /messages?sort=name&order=ASC
   get '/messages' do
     param :sort,  String, default: "name"
     param :order, String, in: ["ASC", "DESC"], transform: :upcase, default: "ASC"
-    
+
     {
       sort: params[:sort],
       order: params[:order]
     }.to_json
   end
-  
+
   # GET /messages/1,2,3,4,5
   get '/messages/:ids' do
     param :ids, Array, required: true
-    
+
     {
       ids: params[:ids]
     }.to_json
   end
-  
+
   # POST /messages/1/response
   post '/messages/:id/response' do
     param :message, String, max: 1024, required: true
-    
+
     {
       message: params[:message]
     }.to_json

data/lib/sinatra/param.rb

@@ -14,7 +14,7 @@ module Sinatra
         validate!(params[name], options)
       rescue
         error = "Invalid parameter, #{name}"
-        if content_type && content_type.match(mime_type(:json))
+        if content_type and content_type.match(mime_type(:json))
           error = {message: error}.to_json
         end
 
@@ -23,14 +23,17 @@ module Sinatra
     end
 
     def one_of(*names)
-      found = 0
+      count = 0
       names.each do |name|
-        found += 1 if params[name] && present?(params[name])
-        if found > 1
+        if params[name] and present?(params[name])
+          count += 1
+          next unless count > 1
+
           error = "Parameters #{names.join(', ')} are mutually exclusive"
-          if content_type.match(mime_type(:json))
+          if content_type and content_type.match(mime_type(:json))
             error = {message: error}.to_json
           end
+
           halt 406, error
         end
       end
@@ -58,44 +61,45 @@ module Sinatra
         case key
         when :required
           raise InvalidParameterError if value && param.nil?
-          when :blank
-            raise InvalidParameterError if !value && case param
-                when String
-                  !(/\S/ === param)
-                when Array, Hash
-                  param.empty?
-                else
-                  param.nil?
+        when :blank
+          raise InvalidParameterError if !value && case param
+              when String
+                !(/\S/ === param)
+              when Array, Hash
+                param.empty?
+              else
+                param.nil?
+            end
+        when :is
+          raise InvalidParameterError unless value === param
+        when :in, :within, :range
+          raise InvalidParameterError unless param.nil? || case value
+              when Range
+                value.include?(param)
+              else
+                Array(value).include?(param)
               end
-          when :is
-            raise InvalidParameterError unless value === param
-          when :in, :within, :range
-            raise InvalidParameterError unless param.nil? || case value
-                when Range
-                  value.include?(param)
-                else
-                  Array(value).include?(param)
-                end
-          when :min
-            raise InvalidParameterError unless param.nil? || value <= param
-          when :max
-            raise InvalidParameterError unless param.nil? || value >= param
-          when :min_length
-            raise InvalidParameterError unless param.nil? || value <= param.length
-          when :max_length
-            raise InvalidParameterError unless param.nil? || value >= param.length
+        when :min
+          raise InvalidParameterError unless param.nil? || value <= param
+        when :max
+          raise InvalidParameterError unless param.nil? || value >= param
+        when :min_length
+          raise InvalidParameterError unless param.nil? || value <= param.length
+        when :max_length
+          raise InvalidParameterError unless param.nil? || value >= param.length
         end
       end
     end
-      
+
     # ActiveSupport #present? and #blank? without patching Object
     def present?(object)
       !blank?(object)
     end
-    
+
     def blank?(object)
       object.respond_to?(:empty?) ? object.empty? : !object
     end
   end
+
   helpers Param
 end

data/lib/sinatra/param/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Param
-    VERSION = "0.1.1"
+    VERSION = '0.1.2'
   end
 end

data/sinatra-param.gemspec

@@ -1,6 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "sinatra/param/version"
+require File.expand_path('../lib/sinatra/param/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "sinatra-param"
@@ -11,12 +10,10 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.summary     = "sinatra-param"
   s.description = "Parameter Contracts for Sinatra"
-  
+
   s.add_dependency "sinatra",   "~> 1.3"
 
-  s.add_development_dependency "rspec", "~> 2.10"
-  s.add_development_dependency "rack-test"
-  s.add_development_dependency "rake",  "~> 0.9.2"
+  s.add_development_dependency 'simplecov'
 
   s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/dummy/app.rb

@@ -0,0 +1,146 @@
+require 'sinatra/base'
+require 'json'
+require 'time'
+
+class App < Sinatra::Base
+  helpers Sinatra::Param
+
+  before do
+    content_type :json
+  end
+
+  get '/coerce/string' do
+    params[:arg] = params[:arg].to_i
+    param :arg, String
+    params.to_json
+  end
+
+  get '/coerce/integer' do
+    param :arg, Integer
+    params.to_json
+  end
+
+  get '/coerce/float' do
+    param :arg, Float
+    params.to_json
+  end
+
+  get '/coerce/time' do
+    param :arg, Time
+    params.to_json
+  end
+
+  get '/coerce/date' do
+    param :arg, Date
+    params.to_json
+  end
+
+  get '/coerce/datetime' do
+    param :arg, DateTime
+    params.to_json
+  end
+
+  get '/coerce/array' do
+    param :arg, Array
+    params.to_json
+  end
+
+  get '/coerce/hash' do
+    param :arg, Hash
+    params.to_json
+  end
+
+  get '/coerce/boolean' do
+    param :arg, :boolean
+    params.to_json
+  end
+
+  # transformations
+  get '/default' do
+    param :sort, String, default: "title"
+    params.to_json
+  end
+
+  get '/transform' do
+    param :order, String, transform: :upcase
+    params.to_json
+  end
+
+  # validations
+  get '/validation/required' do
+    param :arg, String, required: true
+    params.to_json
+  end
+
+  get '/validation/blank/string' do
+    param :arg, String, blank: false
+  end
+
+  get '/validation/blank/array' do
+    param :arg, Array, blank: false
+  end
+
+  get '/validation/blank/hash' do
+    param :arg, Hash, blank: false
+  end
+
+  get '/validation/blank/other' do
+    param :arg, Class, blank: false
+  end
+
+  get '/validation/nonblank/string' do
+    param :arg, String, blank: true
+  end
+
+  get '/validation/is' do
+    param :arg, String, is: 'foo'
+    params.to_json
+  end
+
+  get '/validation/in' do
+    param :arg, String, in: ['ASC', 'DESC']
+    params.to_json
+  end
+
+  get '/validation/within' do
+    param :arg, Integer, within: 1..10
+    params.to_json
+  end
+
+  get '/validation/range' do
+    param :arg, Integer, range: 1..10
+    params.to_json
+  end
+
+  get '/validation/min' do
+    param :arg, Integer, min: 12
+    params.to_json
+  end
+
+  get '/validation/max' do
+    param :arg, Integer, max: 20
+    params.to_json
+  end
+
+  get '/validation/min_length' do
+    param :arg, String, min_length: 5
+    params.to_json
+  end
+
+  get '/validation/max_length' do
+    param :arg, String, max_length: 10
+    params.to_json
+  end
+
+  get '/choice' do
+    param :a, String
+    param :b, String
+    param :c, String
+
+    one_of(:a, :b, :c)
+
+    {
+      message: 'OK'
+    }.to_json
+  end
+end

data/spec/parameter_sets_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'Parameter Sets' do
+  describe 'one_of' do
+    it 'returns 406 on requests that contain more than one mutually exclusive parameter' do
+      params = [
+        {a: 1, b: 2},
+        {b: 2, c: 3},
+        {a: 1, b: 2, c: 3}
+      ]
+      params.each do |param|
+        get('/choice', param) do |response|
+          response.status.should == 406
+          JSON.parse(response.body)['message'].should =~ /mutually exclusive/
+        end
+      end
+    end
+
+    it 'returns successfully for requests that only have one parameter' do
+      params = [
+        {a: 1},
+        {b: 2},
+        {c: 3}
+      ]
+      params.each do |param|
+        get('/choice', param) do |response|
+          response.status.should == 200
+          JSON.parse(response.body)['message'].should =~ /OK/
+        end
+      end
+    end
+  end
+end

data/spec/parameter_transformations_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe 'Parameter Transformations' do
+  describe 'default' do
+    it 'sets a default value when none is given' do
+      get('/default') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['sort'].should == 'title'
+      end
+    end
+  end
+
+  describe 'transform' do
+    it 'transforms the input using to_proc' do
+      get('/transform', order: 'asc') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['order'].should == 'ASC'
+      end
+    end
+  end
+end

data/spec/parameter_type_coercion_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe 'Parameter Types' do
+  describe 'String' do
+    it 'coerces strings' do
+      get('/coerce/string', arg: '1234') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['arg'].should eq('1234')
+      end
+    end
+  end
+
+  describe 'Integer' do
+    it 'coerces integers' do
+      get('/coerce/integer', arg: '1234') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['arg'].should eq(1234)
+      end
+    end
+  end
+
+  describe 'Float' do
+    it 'coerces floats' do
+      get('/coerce/float', arg: '1234') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['arg'].should eq(1234.0)
+      end
+    end
+  end
+
+  describe 'Time' do
+    it 'coerces time' do
+      get('/coerce/time', arg: '20130117') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['arg'].should eq('2013-01-17 00:00:00 -0500')
+      end
+    end
+  end
+
+  describe 'Date' do
+    it 'coerces date' do
+      get('/coerce/date', arg: '20130117') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['arg'].should eq('2013-01-17')
+      end
+    end
+  end
+
+  describe 'DateTime' do
+    it 'coerces datetimes' do
+      get('/coerce/datetime', arg: '20130117') do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['arg'].should eq('2013-01-17T00:00:00+00:00')
+      end
+    end
+  end
+
+  describe 'Array' do
+    it 'coerces arrays' do
+      get('/coerce/array', arg: '1,2,3,4,5') do |response|
+        response.status.should == 200
+        parsed_body = JSON.parse(response.body)
+        parsed_body['arg'].should be_an(Array)
+        parsed_body['arg'].should eq(%w(1 2 3 4 5))
+      end
+    end
+  end
+
+  describe 'Hash' do
+    it 'coerces hashes' do
+      get('/coerce/hash', arg: 'a:b,c:d') do |response|
+        response.status.should == 200
+        parsed_body = JSON.parse(response.body)
+        parsed_body['arg'].should be_an(Hash)
+        parsed_body['arg'].should eq({ 'a' => 'b', 'c' => 'd'})
+      end
+    end
+  end
+
+  describe 'Boolean' do
+    it 'coerces truthy booleans to true' do
+      %w(1 true t yes y).each do |bool|
+        get('/coerce/boolean', arg: bool) do |response|
+          response.status.should == 200
+          JSON.parse(response.body)['arg'].should be_true
+        end
+      end
+    end
+  end
+end