sinatra-schema 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjFmZjFhMTc3NTMzOTFiNjcwZDc0NGVmMjc0MzYyNmE4MjU4ZDU5MA==
+  data.tar.gz: !binary |-
+    NjljZDE3YjZkMGJhYzA2YmE2MjE2NjFjMGQzMDIyYmU3ODRkYzY2Nw==
+SHA512:
+  metadata.gz: !binary |-
+    NmRjN2E4YjRjNzBiZGNhZTBhNTVlM2I1NWUxZGRlYzFjODBkOTQwMzQxMjFi
+    ZDQ0YTViMTQ0MzAzZDc0OTk3M2E2NzgzNzRlOGI0MWY4NTE4YTg1M2E5ZDNi
+    YzQzMWM1OGI3NDE0NWZkODkzMjYxN2EyM2M2NTUwOTM1MDkwNTQ=
+  data.tar.gz: !binary |-
+    YWM3ZTI2YmE3OTk3NTdlOTRmNTQwNzM4ZGQzOTE3ODNlY2VlNDJmMmQyZDU3
+    MTQ2MGRjNDg1MzA0OWUzODJiMzAwZWNlOGYxMzU3NWU2YmE2NjZlNzgxZmUz
+    YjI0M2ViYTZkY2Q3MmM1NjFkOWZlYTBjYTQxMjI5NTg2ZjY5OTA=

data/README.md

@@ -0,0 +1,33 @@
+# 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!
+
+
+## Usage
+
+Register `Sinatra::Schema` and define resources like:
+
+```ruby
+class MyApi < Sinatra::Base
+  register Sinatra::Schema
+
+  resource("/accounts") do
+    title "Account"
+    description "The account of a user signed up to our service"
+    serializer AccountSerializer
+
+    res.link(:post) do
+      title "Create"
+      description "Create a new account"
+      action do
+        Account.create(email: params[:email])
+      end
+    end
+  end
+end
+```
+
+
+## See also
+
+- [sinatra-param](https://github.com/mattt/sinatra-param): nice take on validating request parameters.

data/lib/sinatra/schema/definition.rb

@@ -0,0 +1,7 @@
+module Sinatra
+  module Schema
+    class Definition
+      attr_accessor :description, :example, :format, :type
+    end
+  end
+end

data/lib/sinatra/schema/link.rb

@@ -0,0 +1,47 @@
+module Sinatra
+  module Schema
+    class Link
+      attr_accessor :resource, :title, :description, :href, :method, :properties, :rel, :action
+
+      def initialize(options)
+        @resource = options[:resource]
+        @method   = options[:method]
+        @href     = options[:href]
+      end
+
+      def action(&blk)
+        @action = blk
+      end
+
+      def action_block
+        @action
+      end
+
+      def register(app)
+        link = self
+        app.send(method.downcase, href) do
+          begin
+            link.validate_params!(params)
+            res = link.action_block.call(params)
+            link.resource.validate_response!(res)
+            MultiJson.encode(res)
+          rescue RuntimeError => e
+            halt(400)
+          end
+        end
+      end
+
+      def validate_params!(params)
+        unless properties
+          if params.empty?
+            return
+          else
+            raise "Did not expect params"
+          end
+        end
+
+        Utils.validate_keys!(properties, params)
+      end
+    end
+  end
+end

data/lib/sinatra/schema/resource.rb

@@ -0,0 +1,44 @@
+module Sinatra
+  module Schema
+    class Resource
+      attr_accessor :id, :path, :title, :description, :properties
+
+      def initialize(app, path)
+        @app   = app
+        @path  = path.chomp("/")
+        @links = []
+        @defs  = {}
+      end
+
+      def define(id)
+        @defs[id] = Definition.new
+        yield @defs[id]
+      end
+
+      def link(method, href="/", &blk)
+        href = "#{path}/#{href.chomp("/")}".chomp("/")
+        link = Link.new(resource: self, method: method, href: href)
+        yield(link)
+        link.register(@app)
+        @links << link
+      end
+
+      def validate_response!(res)
+        unless res.is_a?(Hash)
+          raise "Response should return a hash"
+        end
+
+        if properties
+          Utils.validate_keys!(properties, res)
+        end
+      end
+
+      def to_schema
+        {
+          title: title,
+          description: description
+        }
+      end
+    end
+  end
+end

data/lib/sinatra/schema/utils.rb

@@ -0,0 +1,17 @@
+module Sinatra
+  module Schema
+    class Utils
+      def self.validate_keys!(expected, received)
+        missing = expected.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 - expected.map(&:to_s).sort
+        unless extra.empty?
+          raise "Unexpected properties: #{extra}"
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/schema.rb

@@ -0,0 +1,33 @@
+require "sinatra/schema/definition"
+require "sinatra/schema/link"
+require "sinatra/schema/resource"
+require "sinatra/schema/utils"
+
+module Sinatra
+  module Schema
+    def self.registered(app)
+      app.get "/schema" do
+        MultiJson.encode(
+          "$schema" => "http://json-schema.org/draft-04/hyper-schema",
+          "definitions" => app.resources.inject({}) { |result, (id, resource)|
+            result[id] = resource.to_schema
+            result
+          }
+        )
+      end
+    end
+
+    def resources
+      @resources ||= {}
+    end
+
+    def resource(path)
+      res = Resource.new(self, path)
+      yield(res)
+      resources[res.id] = res
+    end
+
+  end
+
+  register Schema
+end

data/spec/integration_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe Sinatra::Schema do
+  it "still works as a regular sinatra app" do
+    get "/regular"
+    assert_equal 200, last_response.status
+    assert_equal "hi", last_response.body
+  end
+
+  it "support resource links" do
+    get "/accounts"
+    assert_equal 200, last_response.status
+    assert_equal({ "email" => "foo@bar.com" },
+      MultiJson.decode(last_response.body))
+  end
+
+  it "support resource links" do
+    post "/accounts", email: "omg"
+    assert_equal 200, last_response.status
+    assert_equal({ "email" => "omg" },
+      MultiJson.decode(last_response.body))
+  end
+
+  it "validates input" do
+    post "/accounts", foo: "bar"
+    assert_equal 400, last_response.status
+  end
+
+  it "exposes the json schema" do
+    get "/schema"
+    assert_equal 200, last_response.status
+    schema = MultiJson.decode(last_response.body)
+    assert_equal "http://json-schema.org/draft-04/hyper-schema",
+      schema["$schema"]
+    assert_equal Hash, schema["definitions"].class
+    assert_equal Hash, schema["definitions"]["account"].class
+    assert_equal "Account", schema["definitions"]["account"]["title"]
+    assert_equal "An account represents an individual signed up to use the service",
+      schema["definitions"]["account"]["description"]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+ENV["RACK_ENV"] = "test"
+
+require "rubygems"
+require "bundler"
+
+Bundler.require(:default, :test)
+
+require "sinatra"
+require "sinatra/schema"
+
+Dir["./spec/support/*"].each { |f| require(f) }
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.expect_with :minitest
+
+  def app
+    TestApp
+  end
+end

data/spec/support/test_app.rb

@@ -0,0 +1,41 @@
+class TestApp < Sinatra::Base
+  register Sinatra::Schema
+
+  get "/regular" do
+    "hi"
+  end
+
+  resource("/accounts") do |res|
+    res.id = :account
+    res.title = "Account"
+    res.description = "An account represents an individual signed up to use the service"
+
+    res.define(:email) do |d|
+      d.description = "unique email address of account"
+      d.example = "username@example.com"
+      d.format = "email"
+      d.type = :string
+    end
+
+    res.properties = [:email]
+
+    res.link(:get) do |link|
+      link.title = "Info"
+      link.rel = "self"
+      link.description = "Info for account"
+      link.action do
+        { email: "foo@bar.com" }
+      end
+    end
+
+    res.link(:post) do |link|
+      link.title = "Create"
+      link.rel = "create"
+      link.description = "Create a new account"
+      link.properties = [:email]
+      link.action do |params|
+        { email: params[:email] }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-schema
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pedro Belo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !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: 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
+  Schema
+email:
+- pedrobelo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sinatra/schema.rb
+- lib/sinatra/schema/definition.rb
+- lib/sinatra/schema/link.rb
+- lib/sinatra/schema/resource.rb
+- lib/sinatra/schema/utils.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_app.rb
+homepage: https://github.com/pedro/sinatra-schema
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: Sinatra extension to support schemas
+test_files: []
+has_rdoc: