sinatra-schema 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTg4NGUxMjY3YWRjOGI3ZTQ4NDI3ZGU5ZTIyNGU2ZmM1OWQ1ZWUxOQ==
-  data.tar.gz: !binary |-
-    MGVlODRhMWE1YzgxZjJhNGYyOWYzYzMyNDMwZWQxNzdiMzZlOTVmNg==
+SHA1:
+  metadata.gz: efba21adbb69d56337bf911bf277b98f99da8781
+  data.tar.gz: f90d52c93a3dc9207f01a075502c383f02f502b4
 SHA512:
-  metadata.gz: !binary |-
-    MzRmMjhjOGEwODY5ZjU5YWU5OTM0MWExMTgwYzllYmVkMjAxNjMwMmI5NTlj
-    ZTg3YmVjOGZjNGRmZDgwMmE1NTcyMWUwMTk2YjIwNGU2ZTIxODNmYmQ0NWVm
-    ZGViNGRhYzgzMzVkNjhmNGMxNGY3M2JlYmE0NDMwMzNmMzk5OTY=
-  data.tar.gz: !binary |-
-    Njg2Mjg4MGM5YzFiNjY5YWNhZGM4YjIxYThlYzgyNDQyYTg4NzMzZWUxMThj
-    MjJkMTU1MzQzNDNjZGNlN2ZiZGNjMGViZjc0NzAzYzk3NjI3M2QyMjkxYmUz
-    OWM3MjdjNDIyOGQ0ZWE2M2NmZTVkN2RhOTc1NzAwMDEyZDNiZjg=
+  metadata.gz: 7eda67c2a0f5d08c9ad7a1b4272c5260c43e96f55cb192e40a1b88f6d0fd3dd9f7c7d9f3fe68cfb1af4daf091e1766bcd75e65cf3cf769ecb83e82a50f3927a2
+  data.tar.gz: cd59d186c53e8c262309a6eae7ec232f4d878b65bc76081d4defe6702c22e15785d4ed0e4299879e6c668f40ffd830da57406f75d412b1e7011975a662d264fa

data/README.md

@@ -5,8 +5,6 @@
 
 Define a schema for your Sinatra application to get requests and responses validated. Dump it schema as a JSON Schema to aid client generation and more!
 
-**Under design**. The reference below might be outdated – please check specs to see the latest.
-
 
 ## Usage
 
@@ -39,18 +37,19 @@ resource("/account") do |res|
 
   res.link(:post) do |link|
     link.property.ref  :email # reuse the property defined above
+    link.property.text :role, optional: true
     link.property.bool :admin
 
-    link.action do |params|
-      user = User.new(email: params[:email])
-      if params[:admin] # params are casted accordingly!
+    link.action do |data|
+      user = User.new(email: data[:email])
+      if data[:admin] # schema params are casted accordingly!
         # ...
       end
     end
   end
 ```
 
-### Cross-resource params
+### Reference properties across resources
 
 Reuse properties from other resources when appropriate:
 
@@ -71,11 +70,8 @@ These are also casted and validated as you'd expect:
 
 ```ruby
 resource("/albums") do |res|
-  resource.link(:post) do |link|
-    link.nested :artist do |a|
-      a.property.text :name
-    end
-  end
+  res.property[:label].text :name
+  res.property[:label].bool :active
 end
 ```
 
@@ -116,6 +112,26 @@ $ rake schema
 }
 ```
 
+### Error handling
+
+By default it will raise a 400 on bad requests (eg: invalid JSON request) and a 422 on bad params (eg: missing mandatory param):
+
+```
+$ curl -d "" http://localhost:5000/account
+{"error":"Missing expected params: email"}
+```
+
+Redefine the error handlers to render a different status or serialize errors differently:
+
+```ruby
+class MyApi < Sinatra::Base
+  register Sinatra::Schema
+
+  error(Sinatra::Schema::BadParams) do |e|
+    halt(422, MultiJson.encode(id: "bad_params", message: e.message))
+  end
+end
+```
 
 ## Context
 

data/lib/sinatra/schema/definition.rb

@@ -1,12 +1,13 @@
 module Sinatra
   module Schema
     class Definition
-      attr_accessor :description, :example, :id, :type
+      attr_accessor :description, :example, :id, :optional, :type
 
       def initialize(options={})
         @description = options[:description]
         @example     = options[:example]
         @id          = options[:id]
+        @optional    = options[:optional]
         @type        = options[:type]
       end
 
@@ -23,8 +24,7 @@ module Sinatra
       end
 
       def valid?(value)
-        # always accept nils for now
-        return if value.nil?
+        return true if value.nil? && optional
 
         case type
         when "boolean"

data/lib/sinatra/schema/dsl/definitions.rb

@@ -30,32 +30,35 @@ module Sinatra
           add Definition.new(options)
         end
 
-        def nested(id)
-          # add a space in the definitions/properties for the nested def:
-          targets.each { |h| h[id] = {} }
+        # support nested properties. eg: property[:foo].text :bar
+        def [](id)
+          # make sure all targets have a sub-hash for this nested def:
+          targets.each { |h| h[id] ||= {} }
 
-          # yield a new DSL with updated targets
-          yield Definitions.new(resource, targets.map { |h| h[id] })
+          # return a new DSL with updated targets so it can be chained:
+          Definitions.new(resource, targets.map { |h| h[id] })
         end
 
-        def ref(id)
-          unless definition = resource.defs[id] || Sinatra::Schema::Root.instance.find_definition(id)
+        def ref(id, ref_to=nil)
+          ref_to ||= id
+          unless definition = resource.defs[ref_to] || Sinatra::Schema::Root.instance.find_definition(ref_to)
             raise BadReference.new(id)
           end
-          add definition, true
+          add definition, true, id
         end
 
         # TODO support other types
 
         protected
 
-        def add(definition, reference=false)
+        def add(definition, reference=false, id=nil)
+          id ||= definition.id
           targets.each_with_index do |hash, i|
             # here's the trick, and here's why the first target is always the
             # resource def: skip it when adding a reference (eg: it's already)
             # in the resource def, just add the property!
             next if reference && i == 0
-            hash[definition.id] = definition
+            hash[id] = definition
           end
         end
       end

data/lib/sinatra/schema/link.rb

@@ -26,6 +26,14 @@ module Sinatra
           end
         end
       end
+
+      def to_schema
+        {
+          description: description,
+          href:        href,
+          method:      method.to_s.upcase,
+        }
+      end
     end
   end
 end

data/lib/sinatra/schema/resource.rb

@@ -41,13 +41,7 @@ module Sinatra
             h[id] = definition.to_schema
             h
           },
-          links: links.map { |link|
-            {
-              description: link.description,
-              href:        link.href,
-              method:      link.method.to_s.upcase,
-            }
-          }
+          links: links.map(&:to_schema)
         }
       end
     end

data/lib/sinatra/schema/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Schema
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/dsl/definitions_spec.rb

@@ -18,15 +18,18 @@ describe Sinatra::Schema::DSL::Definitions do
   end
 
   it "adds nested definitions" do
-    dsl.nested(:user) do |prop|
-      prop.text :email
-      prop.bool :admin
-    end
+    dsl[:user].text :email
+    dsl[:user].bool :admin
     assert_equal 2, resource.defs[:user].size
     assert_equal "string", resource.defs[:user][:email].type
     assert_equal "boolean", resource.defs[:user][:admin].type
   end
 
+  it "sets other options" do
+    dsl.text(:foobar, optional: true)
+    assert_equal true, resource.defs[:foobar].optional
+  end
+
   describe "#ref" do
     let(:definition) { Sinatra::Schema::Definition.new(id: :foobar) }
 
@@ -50,7 +53,15 @@ describe Sinatra::Schema::DSL::Definitions do
       assert_raises(Sinatra::Schema::BadReference) do
         dsl.ref :foobar
       end
+    end
 
+    it "allows references to have a different id" do
+      other = Sinatra::Schema::Resource.new(path: "/others")
+      root.add_resource(other)
+      other.defs[:foobar] = definition
+      dsl.ref :my_foobar, "other/foobar"
+      assert resource.properties.has_key?(:my_foobar)
+      assert_equal :foobar, resource.properties[:my_foobar].id
     end
   end
 end

data/spec/dsl/resources_spec.rb

@@ -23,10 +23,8 @@ describe Sinatra::Schema::DSL::Resources do
     end
 
     it "supports nested properties" do
-      dsl.property.nested :user do |prop|
-        prop.text :email
-        prop.bool :admin
-      end
+      dsl.property[:user].text :email
+      dsl.property[:user].bool :admin
       assert_equal 2, dsl.resource.properties[:user].size
     end
   end

data/spec/param_validation_spec.rb

@@ -26,6 +26,19 @@ describe Sinatra::Schema::ParamValidation do
     end
   end
 
+  it "errors out on required params" do
+    $properties = { foo: Sinatra::Schema::Definition.new(type: "string", optional: false) }
+    assert_raises(Sinatra::Schema::BadParams) do
+      post "/", MultiJson.encode(foo: nil)
+    end
+  end
+
+  it "allows optional params to be nil" do
+    $properties = { foo: Sinatra::Schema::Definition.new(type: "string", optional: true) }
+    post "/", MultiJson.encode(foo: nil)
+    assert_equal 200, last_response.status
+  end
+
   it "errors out on wrong format" do
     $properties = { bool: Sinatra::Schema::Definition.new(type: "boolean") }
     assert_raises(Sinatra::Schema::BadParams) do
@@ -37,7 +50,6 @@ describe Sinatra::Schema::ParamValidation do
     $properties = { foo: { bar: Sinatra::Schema::Definition.new(type: "boolean") }}
     assert_raises(Sinatra::Schema::BadParams) do
       post "/", MultiJson.encode(foo: { bar: "omg" })
-      puts last_response.body
     end
   end
 end

metadata

@@ -1,127 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-schema
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Pedro Belo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-07 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.9.3
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.4
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
 description: Define a schema to validate requests and responses, expose it as JSON
@@ -169,17 +169,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Sinatra extension to support schemas