sinatra-schema 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ed53578697a31d2928747c5e315a6bf74e3a5b1
-  data.tar.gz: 1c8fabb80b8ee50d14186838d1a29f53d4bc039b
+  metadata.gz: a34c267cb9a3dafd8ddf39079c29d49097587b6a
+  data.tar.gz: 0b004738e02c95aa6162f2a9a72cf308f4245c79
 SHA512:
-  metadata.gz: e3a1e7c20a2737d577391748a479bddb1761183777c4797cf6dfc6009076c4caec7dc408aa174eaab7f382d34abc839f49a01728d99e2753e88e5a42c2c668ec
-  data.tar.gz: 7e12db3a44fe1ee3574f5feb3d9fa47c676820d24587a9f85e5d391b7678574288460bd2cef166d6c26055701f147d43fceef2acc5a4ae491f12594af1cf11dd
+  metadata.gz: 3321031aea9981da9d327b73d6cd474e099a6bf513158d5864975af2acf52b6f6a7b40fd1fe858604b20fbd87bd31cccd32122544a1a51124f39c2c3d8b0316f
+  data.tar.gz: 75b6bf7740d69bc5eaebb2a98bd2ced7e8e8fb491caba601ffa73e6fc0774f12a1fdebe692bad7f5996c0749c1c5444af772c72f8dccdbb64792d08525be7a8d

data/README.md

@@ -3,12 +3,12 @@
 [![Gem version](http://img.shields.io/gem/v/sinatra-schema.svg)](https://rubygems.org/gems/sinatra-schema)
 [![Build Status](https://travis-ci.org/pedro/sinatra-schema.svg?branch=master)](https://travis-ci.org/pedro/sinatra-schema)
 
-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!
+Define a schema for your Sinatra application to get requests and responses validated. Dump it as a JSON Schema to aid client generation and more!
 
 
 ## Usage
 
-Register `Sinatra::Schema` to define your resource like:
+Register `Sinatra::Schema` to define resources, like:
 
 ```ruby
 class MyApi < Sinatra::Base
@@ -19,7 +19,7 @@ class MyApi < Sinatra::Base
 
     res.get do |link|
       link.action do
-        # note per definition above we need to serialize "email"
+        # per definition above we need to serialize "email"
         MultiJson.encode(email: current_user.email)
       end
     end
@@ -33,8 +33,6 @@ Links can have properties too:
 
 ```ruby
 resource("/account") do |res|
-  res.property.text :email
-
   res.post do |link|
     link.property.ref  :email # reuse the property defined above
     link.property.text :role, optional: true
@@ -42,7 +40,7 @@ resource("/account") do |res|
 
     link.action do |data|
       user = User.new(email: data[:email])
-      if data[:admin] # schema params are casted accordingly!
+      if data[:admin] # this is a boolean, params are casted accordingly!
         # ...
       end
     end
@@ -64,7 +62,7 @@ resource("/albums") do |res|
 end
 ```
 
-### Nested params
+### Nested properties
 
 These are also casted and validated as you'd expect:
 

data/lib/sinatra/schema.rb

@@ -1,4 +1,3 @@
-require "active_support/inflector"
 require "sinatra/base"
 require "singleton"
 require "multi_json"
@@ -13,7 +12,6 @@ require "sinatra/schema/param_validation"
 require "sinatra/schema/reference"
 require "sinatra/schema/resource"
 require "sinatra/schema/root"
-require "sinatra/schema/utils"
 require "sinatra/schema/dsl/definitions"
 require "sinatra/schema/dsl/links"
 require "sinatra/schema/dsl/resources"

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

@@ -10,21 +10,11 @@ module Sinatra
           @targets  = targets
         end
 
-        def text(id, options={})
-          options.merge!(id: id, type: "string")
-          add Definition.new(options)
-        end
-
         def bool(id, options={})
           options.merge!(id: id, type: "boolean")
           add Definition.new(options)
         end
 
-        def uuid(id, options={})
-          options.merge!(id: id, type: "uuid")
-          add Definition.new(options)
-        end
-
         def datetime(id, options={})
           options.merge!(id: id, type: "datetime")
           add Definition.new(options)          
@@ -35,24 +25,33 @@ module Sinatra
           add Definition.new(options)
         end
 
+        # support references to other properties that are lazily evaluated
+        def ref(id, ref_to=nil)
+          add Reference.new(resource, id, ref_to)
+        end
+
+        def text(id, options={})
+          options.merge!(id: id, type: "string")
+          add Definition.new(options)
+        end
+
+        def uuid(id, options={})
+          options.merge!(id: id, type: "uuid")
+          add Definition.new(options)
+        end
+
         # support nested properties. eg: property[:foo].text :bar
         def [](id)
-          # make sure all targets have a sub-hash for this nested def:
+          # make sure all targets have a sub-hash for this nested def
           targets.each { |h| h[id] ||= {} }
 
-          # return a new DSL with updated targets so it can be chained:
+          # return a new DSL with updated targets so it can be chained
           Definitions.new(resource, targets.map { |h| h[id] })
         end
 
-        def ref(id, ref_to=nil)
-          add Reference.new(resource, id, ref_to), true
-        end
-
-        # TODO support other types
-
         protected
 
-        def add(definition, reference=false)
+        def add(definition)
           targets.each do |target|
             target[definition.id] ||= definition
           end

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

@@ -16,7 +16,7 @@ module Sinatra
         end
 
         def rel(rel)
-          link.rel = rel
+          link.rel = rel.to_sym
         end
 
         def description(description)

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

@@ -13,6 +13,10 @@ module Sinatra
           @resource.description = description
         end
 
+        def id(id)
+          @resource.id = id.to_sym
+        end
+
         def property
           DSL::Definitions.new(resource, [resource.defs, resource.properties])
         end

data/lib/sinatra/schema/error.rb

@@ -20,5 +20,11 @@ module Sinatra
         super(msg)
       end
     end
+
+    class BadResponse < Error
+      def initialize(msg)
+        super(msg)
+      end
+    end
   end
 end

data/lib/sinatra/schema/link.rb

@@ -21,7 +21,7 @@ module Sinatra
             schema_params = parse_params(link.properties)
             validate_params!(schema_params, link.properties)
             res = instance_exec(schema_params, &link.action_block)
-            link.resource.validate_response!(res)
+            link.resource.validate_response!(link.rel, res)
             res
           end
         end

data/lib/sinatra/schema/resource.rb

@@ -11,24 +11,49 @@ module Sinatra
       end
 
       def id
-        @id ||= ActiveSupport::Inflector.singularize(path.split("/").last).to_sym
+        @id ||= path.split("/").last.to_sym
       end
 
       def title
-        @title ||= ActiveSupport::Inflector.singularize(path.split("/").last).capitalize
+        @title ||= id.to_s.capitalize
       end
 
-      def validate_response!(raw)
+      def validate_response!(rel, raw)
         # only validate responses in tests
         return unless ENV["RACK_ENV"] == "test"
 
         res = MultiJson.decode(raw)
-        unless res.is_a?(Hash)
-          raise "Response should return a hash"
+
+        if rel == :instances
+          unless res.is_a?(Array)
+            raise BadResponse.new("Response should return an array")
+          end
+          if sample = res.first
+            validate_properties!(sample)
+          end
+        else
+          unless res.is_a?(Hash)
+            raise BadResponse.new("Response should return a hash")
+          end
+          validate_properties!(res)
+        end
+      end
+
+      def validate_properties!(received)
+        missing = properties.keys.map(&:to_s).sort - received.keys.map(&:to_s).sort
+        unless missing.empty?
+          raise BadResponse.new("Missing properties: #{missing}")
+        end
+
+        extra = received.keys.map(&:to_s).sort - properties.keys.map(&:to_s).sort
+        unless extra.empty?
+          raise BadResponse.new("Unexpected properties: #{extra}")
         end
 
-        unless properties.empty?
-          Utils.validate_keys!(properties, res)
+        properties.each do |id, definition|
+          unless definition.valid?(received[id.to_s])
+            raise BadResponse.new("Bad response property: #{id}")
+          end
         end
       end
     end

data/lib/sinatra/schema/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Schema
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/spec/dsl/definitions_spec.rb

@@ -5,30 +5,22 @@ describe Sinatra::Schema::DSL::Definitions do
   let(:dsl)      { described_class.new(resource, [resource.defs, resource.properties]) }
   let(:root)     { Sinatra::Schema::Root.instance }
 
-  it "adds a string definition to the resource" do
-    dsl.text(:foobar)
-    assert_equal 1, resource.defs.size
-    assert_equal "string", resource.defs[:foobar].type
-  end
-
-  it "adds a boolean definition to the resource" do
+  it "adds boolean definition to the resource" do
     dsl.bool(:foobar)
     assert_equal 1, resource.defs.size
     assert_equal "boolean", resource.defs[:foobar].type
   end
 
-  it "adds a datetime definition to the resource" do
+  it "adds datetime definition to the resource" do
     dsl.datetime(:foobar)
     assert_equal 1, resource.defs.size
     assert_equal "datetime", resource.defs[:foobar].type
   end
 
-  it "adds nested definitions" do
-    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
+  it "adds email definition to the resource" do
+    dsl.email(:foobar)
+    assert_equal 1, resource.defs.size
+    assert_equal "email", resource.defs[:foobar].type
   end
 
   it "adds references" do
@@ -37,6 +29,26 @@ describe Sinatra::Schema::DSL::Definitions do
     assert_instance_of Sinatra::Schema::Reference, resource.defs[:another_property]
   end
 
+  it "adds text definition to the resource" do
+    dsl.text(:foobar)
+    assert_equal 1, resource.defs.size
+    assert_equal "string", resource.defs[:foobar].type
+  end
+
+  it "adds uuid definition to the resource" do
+    dsl.uuid(:foobar)
+    assert_equal 1, resource.defs.size
+    assert_equal "uuid", resource.defs[:foobar].type
+  end
+
+  it "adds nested definitions" do
+    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

data/spec/dsl/links_spec.rb

@@ -10,9 +10,9 @@ describe Sinatra::Schema::DSL::Links do
     assert_equal "foo", dsl.link.title
   end
 
-  it "sets the link rel" do
+  it "sets the link rel, cast to symbol" do
     dsl.rel("foo")
-    assert_equal "foo", dsl.link.rel
+    assert_equal :foo, dsl.link.rel
   end
 
   it "sets the link description" do

data/spec/dsl/resources_spec.rb

@@ -9,6 +9,11 @@ describe Sinatra::Schema::DSL::Resources do
     assert_equal "This is a foobar", dsl.resource.description
   end
 
+  it "sets the id casting to symbol" do
+    dsl.id("account")
+    assert_equal :account, dsl.resource.id
+  end
+
   describe "#property" do
     it "adds new definitions to the resource" do
       dsl.property.text :foo

data/spec/integration_spec.rb

@@ -16,9 +16,9 @@ describe Sinatra::Schema do
     end
 
     it "support resource posts" do
-      post "/accounts", email: "omg"
+      post "/accounts", email: "foo@baz.com"
       assert_equal 200, last_response.status
-      assert_equal({ "email" => "omg" },
+      assert_equal({ "email" => "foo@baz.com" },
         MultiJson.decode(last_response.body))
     end
   end
@@ -45,10 +45,10 @@ describe Sinatra::Schema do
 
     it "generates definitions" do
       assert_equal Hash, @schema["definitions"].class
-      assert_equal Hash, @schema["definitions"]["account"].class
-      assert_equal "Account", @schema["definitions"]["account"]["title"]
+      assert_equal Hash, @schema["definitions"]["accounts"].class
+      assert_equal "Accounts", @schema["definitions"]["accounts"]["title"]
       assert_equal "An account represents an individual signed up to use the service",
-        @schema["definitions"]["account"]["description"]
+        @schema["definitions"]["accounts"]["description"]
     end
   end
 

data/spec/reference_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Sinatra::Schema::Reference do
-  let(:resource) { Sinatra::Schema::Root.instance.resources[:account] }
+  let(:resource) { Sinatra::Schema::Root.instance.resources[:accounts] }
   let(:ref) { described_class.new(resource, :foo, :email) }
   let(:definition) { resource.defs[:email] }
 
@@ -13,7 +13,7 @@ describe Sinatra::Schema::Reference do
     end
 
     it "finds other properties elsewhere in the schema" do
-      ref.ref_spec = "account/email"
+      ref.ref_spec = "accounts/email"
       assert_equal definition, ref.resolve!
     end
 

data/spec/resource_spec.rb

@@ -5,13 +5,71 @@ describe Sinatra::Schema::Resource do
 
   describe "#id" do
     it "is inferred from the path" do
-      assert_equal :artist, resource.id
+      assert_equal :artists, resource.id
     end
   end
 
   describe "#title" do
     it "is inferred from the path" do
-      assert_equal "Artist", resource.title
+      assert_equal "Artists", resource.title
+    end
+  end
+
+  describe "#validate_response!" do
+    before do
+      resource.properties[:email] = Sinatra::Schema::Definition.new(type: "email")
+    end
+
+    describe "instances rel" do
+      it "ensures the response is an array" do
+        assert_raises Sinatra::Schema::BadResponse do
+          resource.validate_response!(:instances, "{}")
+        end
+      end
+
+      it "allows empty responses" do
+        resource.validate_response!(:instances, "[]")
+      end
+
+      it "validates the first element when available" do
+        res = MultiJson.encode([ { email: "foo@bar.com" } ])
+        resource.validate_response!(:instances, res)
+      end
+
+      it "raises when response has a missing property" do
+        res = MultiJson.encode([ {} ])
+        assert_raises Sinatra::Schema::BadResponse do
+          resource.validate_response!(:instances, res)
+        end
+      end
+
+      it "raises when response has an extra property" do
+        res = MultiJson.encode([ { email: "foo@bar.com", other: true } ])
+        assert_raises Sinatra::Schema::BadResponse do
+          resource.validate_response!(:instances, res)
+        end
+      end
+    end
+
+    describe "self/other rel" do
+      it "ensures the response is a hash" do
+        assert_raises Sinatra::Schema::BadResponse do
+          resource.validate_response!(:self, "[]")
+        end
+      end
+
+      it "raises when response has a missing property" do
+        assert_raises Sinatra::Schema::BadResponse do
+          resource.validate_response!(:self, "{}")
+        end
+      end
+
+      it "raises when response has an extra property" do
+        res = MultiJson.encode(email: "foo@bar.com", other: true)
+        assert_raises Sinatra::Schema::BadResponse do
+          resource.validate_response!(:self, res)
+        end
+      end
     end
   end
 end

data/spec/support/test_app.rb

@@ -8,7 +8,7 @@ class TestApp < Sinatra::Base
   resource("/accounts") do |res|
     res.description "An account represents an individual signed up to use the service"
 
-    res.property.text :email,
+    res.property.email :email,
       description: "unique email address of account",
       example:     "username@example.com",
       format:      "email"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Pedro Belo
@@ -10,26 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2014-12-18 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
@@ -147,7 +127,6 @@ files:
 - lib/sinatra/schema/resource.rb
 - lib/sinatra/schema/root.rb
 - lib/sinatra/schema/tasks/schema.rake
-- lib/sinatra/schema/utils.rb
 - lib/sinatra/schema/version.rb
 - spec/definition_spec.rb
 - spec/dsl/definitions_spec.rb

data/lib/sinatra/schema/utils.rb

@@ -1,23 +0,0 @@
-module Sinatra
-  module Schema
-    class Utils
-      def self.validate_keys!(properties, received)
-        missing = properties.keys.map(&:to_s).sort - received.keys.map(&:to_s).sort
-        unless missing.empty?
-          raise "Missing properties: #{missing}"
-        end
-
-        extra = received.keys.map(&:to_s).sort - properties.keys.map(&:to_s).sort
-        unless extra.empty?
-          raise "Unexpected properties: #{extra}"
-        end
-
-        properties.each do |id, definition|
-          unless definition.valid?(received[id.to_s])
-            raise "Bad response property: #{id}"
-          end
-        end
-      end
-    end
-  end
-end