sinatra-param 0.0.2 → 0.1.0

data/Gemfile.lock

@@ -1,17 +1,27 @@
 PATH
   remote: .
   specs:
-    sinatra-param (0.0.2)
+    sinatra-param (0.1.0)
       sinatra (~> 1.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    diff-lcs (1.1.3)
     rack (1.4.1)
     rack-protection (1.2.0)
       rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
     rake (0.9.2.2)
-    rspec (0.6.4)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
     sinatra (1.3.2)
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
@@ -22,7 +32,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  rack-test
   rake (~> 0.9.2)
-  rspec (~> 0.6.1)
+  rspec (~> 2.10)
   sinatra (~> 1.3)
   sinatra-param!

data/README.md

@@ -10,6 +10,7 @@ But figuring out what parameters are expected... well, all bets are off. This Si
 ## Example
 
 ``` ruby
+require 'sinatra/param'
 class App < Sinatra::Base
   helpers Sinatra::Param
 

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

@@ -1,7 +1,7 @@
 require 'sinatra/base'
 require 'json'
 
-require '../lib/sinatra/param'
+require_relative '../sinatra/param'
 
 class App < Sinatra::Base
   helpers Sinatra::Param
@@ -39,5 +39,20 @@ class App < Sinatra::Base
       message: params[:message]
     }.to_json
   end
+
+  # GET /choice?a=foo
+  # GET /choice?b=bar
+  # GET /choice?c=baz
+  get '/choice' do
+    param :a, String
+    param :b, String
+    param :c, String
+
+    one_of(:a, :b, :c)
+
+    {
+      message: 'OK'
+    }.to_json
+  end
 end
 

data/lib/sinatra/param.rb

@@ -1,11 +1,10 @@
 require 'sinatra/base'
+require 'sinatra/param/version'
 require 'time'
 require 'date'
 
 module Sinatra
   module Param
-    VERSION = "0.0.2"
-
     class InvalidParameterError < StandardError; end
 
     def param(name, type, options = {})
@@ -23,10 +22,25 @@ module Sinatra
       end
     end
 
+    def one_of(*names)
+      found = 0
+      names.each do |name|
+        found += 1 if params[name] && present?(params[name])
+        if found > 1
+          error = "Parameters #{names.join(', ')} are mutually exclusive"
+          if content_type.match(mime_type(:json))
+            error = {message: error}.to_json
+          end
+          halt 406, error
+        end
+      end
+    end
+
     private
 
     def coerce(param, type, options = {})
       return nil if param.nil?
+      return param if param.is_a?(type)
       return Integer(param) if type == Integer
       return Float(param) if type == Float
       return String(param) if type == String
@@ -35,15 +49,15 @@ module Sinatra
       return DateTime.parse(param) if type == DateTime
       return Array(param.split(options[:delimiter] || ",")) if type == Array
       return Hash[param.split(options[:delimiter] || ",").map{|c| c.split(options[:separator] || ":")}] if type == Hash
-      return ((/(false|f|no|n|0)$/i === param) ? false : (/(true|t|yes|y|1)$/i === param) ? true : nil) if type == TrueClass || type == FalseClass || type == :boolean
+      return (/(false|f|no|n|0)$/i === param.to_s ? false : (/(true|t|yes|y|1)$/i === param.to_s ? true : nil)) if type == TrueClass || type == FalseClass || type == :boolean
       return nil
     end
 
     def validate!(param, options)
       options.each do |key, value|
         case key
-          when :required
-            raise InvalidParameterError if value && param.nil?
+        when :required
+          raise InvalidParameterError if value && param.nil?
           when :blank
             raise InvalidParameterError if !value && case param
                 when String
@@ -66,10 +80,22 @@ module Sinatra
             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

@@ -0,0 +1,5 @@
+module Sinatra
+  module Param
+    VERSION = "0.1.0"
+  end
+end

data/sinatra-param.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "sinatra/param"
+require "sinatra/param/version"
 
 Gem::Specification.new do |s|
   s.name        = "sinatra-param"
@@ -14,7 +14,8 @@ Gem::Specification.new do |s|
   
   s.add_dependency "sinatra",   "~> 1.3"
 
-  s.add_development_dependency "rspec", "~> 0.6.1"
+  s.add_development_dependency "rspec", "~> 2.10"
+  s.add_development_dependency "rack-test"
   s.add_development_dependency "rake",  "~> 0.9.2"
 
   s.files         = Dir["./**/*"].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }

data/spec/exclude_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'rack/test'
+
+describe 'parameter exclusion' do
+  include Rack::Test::Methods
+  def app; App; end
+
+  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('/exclude', 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},
+      {a: 1, c: 3},
+    ]
+    params.each do |param|
+      get('/exclude', param) do |response|
+        response.status.should == 200
+        JSON.parse(response.body)['message'].should =~ /OK/
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup'
+require 'sinatra/param'
+require 'example/app'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-param
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-14 00:00:00.000000000Z
+date: 2012-08-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70267098070800 !ruby/object:Gem::Requirement
+  requirement: &70343992738160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,32 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70267098070800
+  version_requirements: *70343992738160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70267098069940 !ruby/object:Gem::Requirement
+  requirement: &70343992737380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *70267098069940
+  version_requirements: *70343992737380
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70343992736800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70343992736800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70267098067980 !ruby/object:Gem::Requirement
+  requirement: &70343992736040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,26 +54,28 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70267098067980
+  version_requirements: *70343992736040
 description: Parameter Contracts for Sinatra
 email: m@mattt.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./example/app.rb
-- ./example/config.ru
-- ./example/Gemfile
-- ./example/Gemfile.lock
-- ./example/Procfile
 - ./Gemfile
 - ./Gemfile.lock
+- ./lib/example/app.rb
+- ./lib/example/config.ru
+- ./lib/example/Gemfile
+- ./lib/example/Gemfile.lock
+- ./lib/example/Procfile
+- ./lib/sinatra/param/version.rb
 - ./lib/sinatra/param.rb
 - ./LICENSE
 - ./Rakefile
 - ./README.md
-- ./sinatra-param-0.0.1.gem
 - ./sinatra-param.gemspec
+- spec/exclude_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/mattt/sinatra-param
 licenses: []
 post_install_message: 
@@ -77,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 567877916880817740
+      hash: -1546291879647992050
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,11 +99,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 567877916880817740
+      hash: -1546291879647992050
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: sinatra-param
-test_files: []
+test_files:
+- spec/exclude_spec.rb
+- spec/spec_helper.rb