sinatra-schema 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 603462c6a4aa1a4d10f74c16f6f06572a41e7b20
-  data.tar.gz: 2dba7d6115b90f6bf2b9fc2b3da650b582aea859
+  metadata.gz: 68898f14935c5a727937d1eec3921da16fab59fc
+  data.tar.gz: 148c841cfeb602cb252d13827a621938997b9298
 SHA512:
-  metadata.gz: 8defef282e9e5912c0ca54d19e94acaca55f426a0dcb8168f97cbc93be76326bdccf420bdfdabd2b5c75b078ac8b9aa9194b28c3487ce660c47017d2f6f13fbd
-  data.tar.gz: 7acf6b4143b1d239bb29ef7df0dc035037b95694e6fb07efd295c94a0db0893166558664a593cebcbb6a09b02862b0e1ddb32df528bb41e59c30c3637274be25
+  metadata.gz: 6a43e4d2e18ee81dbb18467881a402782953aa54937cd6dfb6a28c61e54822f63b24d876df3645af58b57fb747ea2bc361b7a448b4eb92ebf733eb5725428563
+  data.tar.gz: 8c2e3ea36d035a7c82dd01f26c62eaae3cefd779bdf0c5e8d861e7b5a909635354b515255af1baaf5213182d84916f7292c5b67f692aae400ef34c8d0d13d50c

data/README.md

@@ -58,10 +58,24 @@ end
 
 resource("/albums") do |res|
   res.property.text :name, description: "Album name"
-  res.property.ref :artist_name, "artists/name"
+  res.property.ref :artist_name, to: "artists/name"
 end
 ```
 
+You can also customize attributes on the reference so that they're different from the original property. For instance:
+
+```ruby
+resource("/artists") do |res|
+  res.property.text :name, description: "Artist name"
+
+  res.patch do |link|
+    link.property.ref :name, optional: true
+  end
+end
+```
+
+In this case the artist name has to be serialized by every endpoint on the resource, but doesn't have to be informed by every request to `PATCH` the resource.
+
 ### Nested properties
 
 These are also casted and validated as you'd expect:

data/lib/sinatra/schema.rb

@@ -41,8 +41,8 @@ module Sinatra
       Root.instance
     end
 
-    def resource(path)
-      spec = DSL::Resources.new(self, path)
+    def resource(path_or_id)
+      spec = DSL::Resources.new(self, path_or_id)
       yield(spec)
       schema_root.add_resource(spec.resource)
     end

data/lib/sinatra/schema/definition.rb

@@ -22,11 +22,15 @@ module Sinatra
           Time.parse(value.to_s)
         when "email", "string", "uuid"
           value.to_s
+        when "integer"
+          value.to_i
+        when "object"
+          value
         end
       end
 
-      def valid?(value)
-        return true if value.nil? && optional
+      def valid?(value, skip_nils=optional)
+        return true if value.nil? && skip_nils
 
         case type
         when "boolean"
@@ -35,6 +39,10 @@ module Sinatra
           value.to_s =~ /^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](\.[0-9]+)?(Z|[\-+][0-9]{2}:[0-5][0-9])$/
         when "email"
           value.to_s =~ /\A[^@\s]+@([^@\s]+\.)+[^@\s]+\z/
+        when "integer"
+          value.to_s =~ /\A\d*\z/
+        when "object"
+          value.is_a?(Hash)
         when "string"
           value.is_a?(String)
         when "uuid"

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

@@ -25,9 +25,19 @@ module Sinatra
           add Definition.new(options)
         end
 
+        def int(id, options={})
+          options.merge!(id: id, type: "integer")
+          add Definition.new(options)
+        end
+
+        def object(id, options={})
+          options.merge!(id: id, type: "object")
+          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)
+        def ref(id, options={})
+          add Reference.new(resource, id, options)
         end
 
         def text(id, options={})

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

@@ -4,9 +4,13 @@ module Sinatra
       class Resources
         attr_accessor :app, :resource
 
-        def initialize(app, path)
-          @app      = app
-          @resource = Resource.new(path: path)
+        def initialize(app, path_or_id)
+          @app = app
+          if path_or_id.is_a?(Symbol)
+            @resource = Resource.new(id: path_or_id)
+          else
+            @resource = Resource.new(path: path_or_id)
+          end
         end
 
         def description(description)
@@ -17,6 +21,10 @@ module Sinatra
           @resource.id = id.to_sym
         end
 
+        def title(title)
+          @resource.title = title
+        end
+
         def property
           DSL::Definitions.new(resource, [resource.defs, resource.properties])
         end

data/lib/sinatra/schema/json_schema.rb

@@ -62,6 +62,8 @@ module Sinatra
           ["string", "date-time"]
         when "email"
           ["string", "email"]
+        when "integer"
+          "integer"
         when "string"
           "string"
         when "uuid"

data/lib/sinatra/schema/reference.rb

@@ -1,20 +1,25 @@
 module Sinatra
   module Schema
     class Reference
-      attr_accessor :id, :ref_spec, :referenced_def, :resource
+      attr_accessor :id, :options, :ref_spec, :referenced_def, :resource
 
       # helper to lazily delegate method to the referenced definition
       def self.delegate(attribute)
         define_method(attribute) do |*args|
+          # support overriding attributes. example: referenced
+          # definition is optional, but parameter is not
+          return options[attribute] if options.has_key?(attribute)
+
           resolve!
           referenced_def.send(attribute, *args)
         end
       end
 
-      def initialize(resource, id, ref_spec=nil)
-        @id = id
-        @ref_spec = ref_spec || id
+      def initialize(resource, id, options={})
         @resource = resource
+        @id       = id
+        @ref_spec = options[:to] || id
+        @options  = options
       end
 
       def resolve!
@@ -30,7 +35,12 @@ module Sinatra
       delegate :example
       delegate :optional
       delegate :type
-      delegate :valid?
+
+      # redefine to make sure overrides on "optional" are considered
+      def valid?(value)
+        resolve!
+        referenced_def.valid?(value, self.optional)
+      end
     end
   end
 end

data/lib/sinatra/schema/resource.rb

@@ -4,7 +4,8 @@ module Sinatra
       attr_accessor :id, :path, :title, :defs, :links, :description, :properties
 
       def initialize(options)
-        @path       = options.fetch(:path).chomp("/")
+        @id         = options[:id]
+        @path       = (options[:path] || "").chomp("/")
         @links      = []
         @defs       = {}
         @properties = {}
@@ -40,7 +41,12 @@ module Sinatra
       end
 
       def validate_properties!(received)
-        missing = properties.keys.map(&:to_s).sort - received.keys.map(&:to_s).sort
+        required_properties = properties.map do |k, prop|
+          # ignore nested properties for now, we'll cover these next
+          k unless prop.is_a?(Hash) || prop.optional
+        end.compact
+
+        missing = required_properties.map(&:to_s).sort - received.keys.map(&:to_s).sort
         unless missing.empty?
           raise BadResponse.new("Missing properties: #{missing}")
         end

data/lib/sinatra/schema/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Schema
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

data/spec/definition_spec.rb

@@ -26,6 +26,11 @@ describe Sinatra::Schema::Definition do
       assert_equal "UTC", t.zone
     end
 
+    it "casts integers" do
+      definition.type = "integer"
+      assert_equal 42, definition.cast("42")
+    end
+
     it "casts text" do
       definition.type = "string"
       assert_equal "123", definition.cast(123)
@@ -46,6 +51,18 @@ describe Sinatra::Schema::Definition do
       refute definition.valid?("foobar.com")
     end
 
+    it "validates integers" do
+      definition.type = "integer"
+      assert definition.valid?(42)
+      refute definition.valid?("42omg")
+    end
+
+    it "validates objects" do
+      definition.type = "object"
+      assert definition.valid?(good: true)
+      refute definition.valid?("bad")
+    end
+
     it "validates text" do
       definition.type = "string"
       assert definition.valid?("foo")

data/spec/dsl/definitions_spec.rb

@@ -23,6 +23,18 @@ describe Sinatra::Schema::DSL::Definitions do
     assert_equal "email", resource.defs[:foobar].type
   end
 
+  it "adds integer definition to the resource" do
+    dsl.int(:foobar)
+    assert_equal 1, resource.defs.size
+    assert_equal "integer", resource.defs[:foobar].type
+  end
+
+  it "adds object definition to the resource" do
+    dsl.object(:foobar)
+    assert_equal 1, resource.defs.size
+    assert_equal "object", resource.defs[:foobar].type
+  end
+
   it "adds references" do
     dsl.ref(:another_property)
     assert_equal 1, resource.defs.size

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 resource title" do
+    dsl.title("Foobar")
+    assert_equal "Foobar", dsl.resource.title
+  end
+
   it "sets the id casting to symbol" do
     dsl.id("account")
     assert_equal :account, dsl.resource.id

data/spec/json_schema_spec.rb

@@ -40,6 +40,12 @@ describe Sinatra::Schema::JsonSchema do
       assert_equal "email", schema[:format]
     end
 
+    it "handles the integer format" do
+      definition.type = "integer"
+      schema = json_schema.dump_definition(definition)
+      assert_equal "integer", schema[:type]
+    end
+
     it "handles the uuid format" do
       definition.type = "uuid"
       schema = json_schema.dump_definition(definition)

data/spec/reference_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Sinatra::Schema::Reference do
   let(:resource) { Sinatra::Schema::Root.instance.resources[:accounts] }
-  let(:ref) { described_class.new(resource, :foo, :email) }
+  let(:ref) { described_class.new(resource, :email) }
   let(:definition) { resource.defs[:email] }
 
   describe "#resolve!" do
@@ -49,5 +49,10 @@ describe Sinatra::Schema::Reference do
     it "#valid?" do
       assert_equal definition.valid?("foo"), ref.valid?("foo")
     end
+
+    it "supports overriding delegated methods" do
+      ref.options[:description] = "diff"
+      assert_equal "diff", ref.description
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-schema
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Pedro Belo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-18 00:00:00.000000000 Z
+date: 2015-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json