sinatra-api 1.0.2 → 1.1.2

data/spec/integration/parameter_validators_spec.rb

@@ -0,0 +1,3 @@
+describe Sinatra::API::ParameterValidator do
+  include_examples 'integration specs'
+end

data/spec/integration/parameters_spec.rb

@@ -0,0 +1,144 @@
+describe Sinatra::API::Parameters do
+  include_examples 'integration specs'
+
+  context 'defining parameters' do
+    context 'required parameters' do
+      it 'should define a required parameter using hash style' do
+        app.get '/' do
+          api_required!({
+            id: nil
+          })
+        end
+
+        get '/'
+        last_response.status.should == 400
+        last_response.body.should match(/Missing required parameter :id/)
+      end
+
+      it 'should define required parameters using list style' do
+        app.post '/' do
+          api_required!([ :id, :name ])
+        end
+
+        post '/'
+        last_response.status.should == 400
+        last_response.body.should match(/missing required parameter :id/i)
+
+        post '/', { id: 10 }.to_json
+        last_response.status.should == 400
+        last_response.body.should match(/missing required parameter :name/i)
+      end
+
+      it 'should define a single required parameter' do
+        app.get '/' do
+          api_parameter! :id, required: true
+        end
+
+        get '/'
+        last_response.status.should == 400
+        last_response.body.should match(/Missing required parameter :id/)
+      end
+    end
+
+    context 'optional parameters' do
+      it 'should define an optional parameter using hash style' do
+        app.get '/' do
+          api_optional!({
+            id: nil
+          })
+        end
+
+        get '/'
+        last_response.status.should == 200
+      end
+
+      it 'should define a single required parameter' do
+        app.get '/' do
+          api_parameter! :id
+        end
+
+        get '/'
+        last_response.status.should == 200
+      end
+
+      it 'should define optional parameters using list style' do
+        app.post '/' do
+          api_optional! [ :id, :name ]
+          api_params.to_json
+        end
+
+        post '/', { id: 5, name: 'test' }.to_json
+        last_response.status.should == 200
+        last_response.body.should == { id: 5, name: 'test' }.to_json
+      end
+    end
+  end
+
+  it "should reject a request missing a required parameter" do
+    app.get '/' do
+      api_required! [ :id ]
+    end
+
+    get '/'
+    last_response.status.should == 400
+    last_response.body.should match(/Missing required parameter :id/)
+  end
+
+  it "should accept a request satisfying required parameters" do
+    app.get '/' do
+      api_required! [ :id ]
+    end
+
+    get '/', { id: 5 }
+    last_response.status.should == 200
+  end
+
+  it "should accept a request not satisfying optional parameters" do
+    app.get '/' do
+      api_required! [ :id ]
+      api_optional! [ :name ]
+    end
+
+    get '/', { id: 5 }
+    last_response.status.should == 200
+  end
+
+  it "should apply parameter conditions" do
+    app.get '/' do
+      api_optional!({
+        name: lambda { |v|
+          unless (v || '').match /ahmad/
+            "Unexpected name."
+          end
+        }
+      })
+    end
+
+    get '/', { name: 'foobar' }
+    last_response.status.should == 400
+    last_response.body.should match(/Unexpected name/)
+
+    get '/', { name: 'ahmad' }
+    last_response.status.should == 200
+  end
+
+  it "should pick parameters" do
+    app.get '/' do
+      api_optional!({
+        name: nil
+      })
+
+      api_params.to_json
+    end
+
+    get '/', {
+      name: 'foobar',
+      some: 'thing'
+    }
+
+    last_response.body.should == {
+      name: 'foobar'
+    }.to_json
+  end
+
+end

data/spec/integration/resources_spec.rb

@@ -0,0 +1,17 @@
+describe Sinatra::API::Resources do
+  include_examples 'integration specs'
+
+  it 'should locate a resource' do
+    app.get '/items/:item_id', requires: [ :item ] do
+      @item.to_json
+    end
+
+    get '/items/1'
+    last_response.status.should == 200
+    last_response.body.should == {}.to_json
+
+    get '/items/2'
+    last_response.status.should == 404
+    last_response.body.should match /No such resource/
+  end
+end

data/spec/spec_helper.rb

@@ -8,25 +8,19 @@ require 'rack/test'
 
 class SinatraAPITestApp < Sinatra::Base
   register Sinatra::API
+  Sinatra::API.configure({
+    verbose: false,
+    with_errors: true
+  })
+
 end
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   Thread.abort_on_exception = true
 
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus => true
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
   config.order = 'random'
 
   include Rack::Test::Methods

data/spec/unit/callbacks_spec.rb

@@ -1,99 +1,2 @@
-describe "Helpers" do
-  before :each do
-    Router.purge('/')
-  end
-
-  it "should reject a request missing a required parameter" do
-    app.get '/' do
-      api_required!({
-        id: nil
-      })
-    end
-
-    get '/'
-    last_response.status.should == 400
-    last_response.body.should match(/Missing required parameter :id/)
-  end
-
-  it "should accept a request satisfying required parameters" do
-    app.get '/' do
-      api_required!({
-        id: nil
-      })
-    end
-
-    get '/', { id: 5 }
-    last_response.status.should == 200
-  end
-
-  it "should accept a request not satisfying optional parameters" do
-    app.get '/' do
-      api_required!({
-        id: nil
-      })
-      api_optional!({
-        name: nil
-      })
-    end
-
-    get '/', { id: 5 }
-    last_response.status.should == 200
-  end
-
-  it "should apply parameter conditions" do
-    app.get '/' do
-      api_optional!({
-        name: lambda { |v|
-          unless (v || '').match /ahmad/
-            "Unexpected name."
-          end
-        }
-      })
-    end
-
-    get '/', { name: 'foobar' }
-    last_response.status.should == 400
-    last_response.body.should match(/Unexpected name/)
-
-    get '/', { name: 'ahmad' }
-    last_response.status.should == 200
-  end
-
-  it "should pick parameters" do
-    app.get '/' do
-      api_optional!({
-        name: nil
-      })
-
-      api_params.to_json
-    end
-
-    get '/', {
-      name: 'foobar',
-      some: 'thing'
-    }
-
-    last_response.body.should == {
-      name: 'foobar'
-    }.to_json
-  end
-
-  it "should locate a resource" do
-    app.get '/items/:item_id', requires: [ :item ] do
-      @item.to_json
-    end
-
-    get '/items/1'
-    last_response.status.should == 200
-    last_response.body.should == {}.to_json
-
-    get '/items/2'
-    last_response.status.should == 404
-    last_response.body.should match /No such resource/
-  end
-
-  it "should define a resource alias" do
-    Sinatra::API.alias_resource :item, :item_alias
-    Sinatra::API.aliases_for(:item).should == [ 'item_alias' ]
-  end
+describe Sinatra::API::Callbacks do
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -130,21 +130,35 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sinatra/api.rb
+- lib/sinatra/api/config.rb
 - lib/sinatra/api/callbacks.rb
 - lib/sinatra/api/helpers.rb
 - lib/sinatra/api/parameters.rb
+- lib/sinatra/api/parameter_validator.rb
 - lib/sinatra/api/resource_aliases.rb
 - lib/sinatra/api/resources.rb
+- lib/sinatra/api/error_handler.rb
 - lib/sinatra/api/version.rb
+- lib/sinatra/api/parameter_validators/string_validator.rb
+- lib/sinatra/api/parameter_validators/float_validator.rb
+- lib/sinatra/api/parameter_validators/integer_validator.rb
 - spec/unit/callbacks_spec.rb
 - spec/unit/resource_aliases_spec.rb
+- spec/integration/parameters_spec.rb
+- spec/integration/parameter_validators_spec.rb
 - spec/integration/api_spec.rb
-- spec/integration/helpers_spec.rb
+- spec/integration/resources_spec.rb
 - spec/integration/resource_aliases_spec.rb
+- spec/integration/parameter_validators/integer_validator_spec.rb
+- spec/integration/parameter_validators/float_validator_spec.rb
+- spec/integration/parameter_validators/string_validator_spec.rb
 - spec/support/integration_specs.rb
 - spec/support/aliasing_specs.rb
 - spec/helpers/fixtures.rb
+- spec/helpers/api_calls.rb
 - spec/helpers/router.rb
+- spec/helpers/rack_test_api_response.rb
+- spec/helpers/rspec_api_response_matchers.rb
 - spec/spec_helper.rb
 - LICENSE
 - README.md

data/spec/integration/helpers_spec.rb

@@ -1,92 +0,0 @@
-describe Sinatra::API::Helpers do
-  include_examples 'integration specs'
-
-  it "should reject a request missing a required parameter" do
-    app.get '/' do
-      api_required!({
-        id: nil
-      })
-    end
-
-    get '/'
-    last_response.status.should == 400
-    last_response.body.should match(/Missing required parameter :id/)
-  end
-
-  it "should accept a request satisfying required parameters" do
-    app.get '/' do
-      api_required!({
-        id: nil
-      })
-    end
-
-    get '/', { id: 5 }
-    last_response.status.should == 200
-  end
-
-  it "should accept a request not satisfying optional parameters" do
-    app.get '/' do
-      api_required!({
-        id: nil
-      })
-      api_optional!({
-        name: nil
-      })
-    end
-
-    get '/', { id: 5 }
-    last_response.status.should == 200
-  end
-
-  it "should apply parameter conditions" do
-    app.get '/' do
-      api_optional!({
-        name: lambda { |v|
-          unless (v || '').match /ahmad/
-            "Unexpected name."
-          end
-        }
-      })
-    end
-
-    get '/', { name: 'foobar' }
-    last_response.status.should == 400
-    last_response.body.should match(/Unexpected name/)
-
-    get '/', { name: 'ahmad' }
-    last_response.status.should == 200
-  end
-
-  it "should pick parameters" do
-    app.get '/' do
-      api_optional!({
-        name: nil
-      })
-
-      api_params.to_json
-    end
-
-    get '/', {
-      name: 'foobar',
-      some: 'thing'
-    }
-
-    last_response.body.should == {
-      name: 'foobar'
-    }.to_json
-  end
-
-  it "should locate a resource" do
-    app.get '/items/:item_id', requires: [ :item ] do
-      @item.to_json
-    end
-
-    get '/items/1'
-    last_response.status.should == 200
-    last_response.body.should == {}.to_json
-
-    get '/items/2'
-    last_response.status.should == 404
-    last_response.body.should match /No such resource/
-  end
-end