committee 0.4.14 → 1.0.0

data/test/request_validator_test.rb

@@ -0,0 +1,34 @@
+require_relative "test_helper"
+
+describe Committee::RequestValidator do
+  before do
+    @schema =
+      JsonSchema.parse!(MultiJson.decode(File.read("./test/data/schema.json")))
+    # POST /apps/:id
+    @link = @link = @schema.properties["app"].links[0]
+  end
+
+  it "passes through a valid request" do
+    params = {
+      "name" => "heroku-api",
+    }
+    call(params)
+  end
+
+  it "detects a parameter of the wrong pattern" do
+    params = {
+      "name" => "%@!"
+    }
+    e = assert_raises(Committee::InvalidRequest) do
+      call(params)
+    end
+    message = %{Invalid request.\n\nAt "/schema/app": Expected string to match pattern "/^[a-z][a-z0-9-]{3,30}$/", value was: %@!.}
+    assert_equal message, e.message
+  end
+
+  private
+
+  def call(params)
+    Committee::RequestValidator.new.call(@link, params)
+  end
+end

data/test/response_generator_test.rb

@@ -2,31 +2,31 @@ require_relative "test_helper"
 
 describe Committee::ResponseGenerator do
   before do
-    @schema = Committee::Schema.new(File.read("./test/data/schema.json"))
-    @generator = Committee::ResponseGenerator.new(
-      @schema,
-      @schema["app"],
-      @schema["app"]["links"][0]
-    )
+    @schema =
+      JsonSchema.parse!(MultiJson.decode(File.read("./test/data/schema.json")))
+    # GET /apps/:id
+    @get_link = @link = @schema.properties["app"].links[2]
+    # GET /apps
+    @list_link = @schema.properties["app"].links[3]
   end
 
   it "generates string properties" do
-    data = @generator.call
+    data = call
     assert data["name"].is_a?(String)
   end
 
   it "generates non-string properties" do
-    data = @generator.call
-    assert [FalseClass, TrueClass].include?(data["maintenance"].class)
+    data = call
+    assert_includes [FalseClass, TrueClass], data["maintenance"].class
   end
 
   it "wraps list data in an array" do
-    @generator = Committee::ResponseGenerator.new(
-      @schema,
-      @schema["app"],
-      @schema["app"]["links"][3]
-    )
-    data = @generator.call
+    @link = @list_link
+    data = call
     assert data.is_a?(Array)
   end
+
+  def call
+    Committee::ResponseGenerator.new.call(@link)
+  end
 end

data/test/response_validator_test.rb

@@ -3,10 +3,16 @@ require_relative "test_helper"
 describe Committee::ResponseValidator do
   before do
     @data = ValidApp.dup
-    @schema = Committee::Schema.new(File.read("./test/data/schema.json"))
+    @headers = {
+      "Content-Type" => "application/json"
+    }
+    @schema =
+      JsonSchema.parse!(MultiJson.decode(File.read("./test/data/schema.json")))
     # GET /apps/:id
-    @link_schema = @schema["app"]["links"][2]
-    @type_schema = @schema["app"]
+    @get_link = @link = @schema.properties["app"].links[2]
+    # GET /apps
+    @list_link = @schema.properties["app"].links[3]
+    @type_schema = @schema.properties["app"]
   end
 
   it "passes through a valid response" do
@@ -15,132 +21,35 @@ describe Committee::ResponseValidator do
 
   it "passes through a valid list response" do
     @data = [@data]
-    # GET /apps
-    @link_schema = @schema["app"]["links"][3]
-    call
-  end
-
-  it "passes through a valid list response with non-default title" do
-    @data = [@data]
-    @link_schema = @schema["app"]["links"][4]
+    @link = @list_link
     call
   end
 
   it "detects an improperly formatted list response" do
-    # GET /apps
-    @link_schema = @schema["app"]["links"][3]
+    @link = @list_link
     e = assert_raises(Committee::InvalidResponse) { call }
     message = "List endpoints must return an array of objects."
     assert_equal message, e.message
   end
 
-  it "detects missing keys in response" do
-    @data.delete("name")
-    e = assert_raises(Committee::InvalidResponse) { call }
-    message = %r{Missing keys in response: name.}
-    assert_match message, e.message
-  end
-
-  it "detects extra keys in response" do
-    @data.merge!("tier" => "important")
+  it "detects an invalid response Content-Type" do
+    @headers = {}
     e = assert_raises(Committee::InvalidResponse) { call }
-    message = %r{Extra keys in response: tier.}
-    assert_match message, e.message
-  end
-
-  it "detects mismatched types" do
-    @data.merge!("maintenance" => "not-bool")
-    e = assert_raises(Committee::InvalidType) { call }
-    message = %{Invalid type at "maintenance": expected "not-bool" to be ["boolean"].}
-    assert_equal message, e.message
-  end
-
-  it "detects bad formats" do
-    @data.merge!("id" => "123")
-    e = assert_raises(Committee::InvalidFormat) { call }
-    message = %{Invalid format at "id": expected "123" to be "uuid".}
+    message =
+      %{"Content-Type" response header must be set to "application/json".}
     assert_equal message, e.message
   end
 
-  it "detects bad patterns" do
+  it "raises errors generated by json_schema" do
     @data.merge!("name" => "%@!")
-    e = assert_raises(Committee::InvalidPattern) { call }
-    message = %{Invalid pattern at "name": expected %@! to match "(?-mix:^[a-z][a-z0-9-]{3,30}$)".}
-    assert_equal message, e.message
-  end
-
-  it "accepts date-time format without milliseconds" do
-    validator = Committee::ResponseValidator.new(
-      @data,
-      @schema,
-      @link_schema,
-      @schema["app"])
-
-    value = "2014-03-10T00:00:00Z"
-    assert_nil validator.check_format!("date-time", value, ["example"])
-  end
-
-  it "accepts date-time format with milliseconds" do
-    validator = Committee::ResponseValidator.new(
-      @data,
-      @schema,
-      @link_schema,
-      @schema["app"])
-
-    value = "2014-03-10T00:00:00.123Z"
-    assert_nil validator.check_format!("date-time", value, ["example"])
-  end
-
-  it "accepts a simple array" do
-    @data = ValidAccount.dup
-    @data["flags"] = @data["flags"].dup
-    @link_schema = @schema["account"]["links"][1]
-    @type_schema = @schema["account"]
-
-    call
-  end
-
-  it "validates an array of objects" do
-    @data = ValidAccount.dup
-    @data["credit_cards"] = @data["credit_cards"].dup
-    @link_schema = @schema["account"]["links"][0]
-    @type_schema = @schema["account"]
-
-    call
-  end
-
-  it "detects a simple array with an item of the wrong type" do
-    @data = ValidAccount.dup
-    @data["flags"] = @data["flags"].dup
-    @data["flags"] << false
-    @link_schema = @schema["account"]["links"][1]
-    @type_schema = @schema["account"]
-
-    e = assert_raises(Committee::InvalidType) { call }
-    message = %{Invalid type at "flags": expected false to be ["string"].}
-    assert_equal message, e.message
-  end
-
-  it "rejects an invalid pattern match" do
-    @data = ValidAccount.dup
-    @data["credit_cards"] = @data["credit_cards"].dup
-    @data["credit_cards"] << {"account_number" => "1234-1234-1234-HUGZ", "name" => "Rodney Mullen", "security_code" => 123}
-    @link_schema = @schema["account"]["links"][0]
-    @type_schema = @schema["account"]
-
-    e = assert_raises(Committee::InvalidPattern) { call }
-    message = %{Invalid pattern at "credit_cards:account_number": expected 1234-1234-1234-HUGZ to match "(?-mix:[0-9]{4}\\-[0-9]{4}\\-[0-9]{4}\\-[0-9]{4}$)".}
+    e = assert_raises(Committee::InvalidResponse) { call }
+    message = %{Invalid response.\n\nAt "/schema/app": Expected string to match pattern "/^[a-z][a-z0-9-]{3,30}$/", value was: %@!.}
     assert_equal message, e.message
   end
 
   private
 
   def call
-    Committee::ResponseValidator.new(
-      @data,
-      @schema,
-      @link_schema,
-      @type_schema
-    ).call
+    Committee::ResponseValidator.new(@link).call(@headers, @data)
   end
 end

data/test/router_test.rb

@@ -2,25 +2,25 @@ require_relative "test_helper"
 
 describe Committee::Router do
   before do
-    data = File.read("./test/data/schema.json")
-    schema = Committee::Schema.new(data)
+    data = MultiJson.decode(File.read("./test/data/schema.json"))
+    schema = JsonSchema.parse!(data)
     @router = Committee::Router.new(schema)
   end
 
   it "builds routes without parameters" do
-    refute_nil @router.routes?("GET", "/apps")[0]
+    refute_nil @router.routes?("GET", "/apps")
   end
 
   it "builds routes with parameters" do
-    refute_nil @router.routes?("GET", "/apps/123")[0]
+    refute_nil @router.routes?("GET", "/apps/123")
   end
 
   it "doesn't match anything on a /" do
-    assert_nil @router.routes?("GET", "/")[0]
+    assert_nil @router.routes?("GET", "/")
   end
 
   it "takes a prefix" do
     # this is a sociopathic example
-    refute_nil @router.routes?("GET", "/kpi/apps/123", prefix: "/kpi")[0]
+    refute_nil @router.routes?("GET", "/kpi/apps/123", prefix: "/kpi")
   end
 end

data/test/test/methods_test.rb

@@ -13,20 +13,10 @@ describe Committee::Middleware::Stub do
   end
 
   describe "#assert_schema_content_type" do
-    it "passes through a valid response" do
-      @app = new_rack_app(MultiJson.encode([ValidApp]))
-      get "/apps"
+    it "warns about deprecation" do
+      mock(Committee).warn_deprecated.with_any_args
       assert_schema_content_type
     end
-
-    it "detects an invalid response Content-Type" do
-      @app = new_rack_app(MultiJson.encode([ValidApp]), {})
-      get "/apps"
-      e = assert_raises(Committee::InvalidResponse) do
-        assert_schema_content_type
-      end
-      assert_match /response header must be set to/i, e.message
-    end
   end
 
   describe "#assert_schema_conform" do
@@ -45,15 +35,12 @@ describe Committee::Middleware::Stub do
       assert_match /response header must be set to/i, e.message
     end
 
-    it "detects missing keys in response" do
-      data = ValidApp.dup
-      data.delete("name")
-      @app = new_rack_app(MultiJson.encode([data]))
+    it "warns when sending a deprecated string" do
+      stub(self).schema_contents { File.read(schema_path) }
+      mock(Committee).warn_deprecated.with_any_args
+      @app = new_rack_app(MultiJson.encode([ValidApp]))
       get "/apps"
-      e = assert_raises(Committee::InvalidResponse) do
-        assert_schema_conform
-      end
-      assert_match /missing keys/i, e.message
+      assert_schema_conform
     end
   end
 

data/test/test_helper.rb

@@ -1,48 +1,12 @@
 require "minitest"
 require "minitest/spec"
 require "minitest/autorun"
-
-require "bundler/setup"
-Bundler.require(:development)
+require "rack/test"
+require "rr"
 
 require_relative "../lib/committee"
 
 ValidApp = {
-  "archived_at"                    => "2012-01-01T12:00:00Z",
-  "buildpack_provided_description" => "Ruby/Rack",
-  "created_at"                     => "2012-01-01T12:00:00Z",
-  "git_url"                        => "git@heroku.com/example.git",
-  "id"                             => "01234567-89ab-cdef-0123-456789abcdef",
-  "maintenance"                    => false,
-  "name"                           => "example",
-  "owner"                          => {
-    "email"                        => "username@example.com",
-    "id"                           => "01234567-89ab-cdef-0123-456789abcdef"
-  },
-  "region"                         => {
-    "id"                           => "01234567-89ab-cdef-0123-456789abcdef",
-    "name"                         => "us"
-  },
-  "released_at"                    => "2012-01-01T12:00:00Z",
-  "repo_size"                      => 0,
-  "slug_size"                      => 0,
-  "stack"                          => {
-    "id"                           => "01234567-89ab-cdef-0123-456789abcdef",
-    "name"                         => "cedar"
-  },
-  "updated_at"                     => "2012-01-01T12:00:00Z",
-  "web_url"                        => "http://example.herokuapp.com"
-}.freeze
-
-ValidAccount = {
-  "allow_tracking" => true,
-  "beta"           => true,
-  "created_at"     => "2012-01-01T12:00:00Z",
-  "email"          => "username@example.com",
-  "id"             => "01234567-89ab-cdef-0123-456789abcdef",
-  "last_login"     => "2012-01-01T12:00:00Z",
-  "updated_at"     => "2012-01-01T12:00:00Z",
-  "verified"       => true,
-  "flags"          => ["foo", "bar"],
-  "credit_cards"   => [{"account_number" => "1234-1234-1234-1234", "name" => "Rodney Mullen", "security_code" => 123}]
+  "maintenance" => false,
+  "name"        => "example",
 }.freeze

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: committee
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,10 +10,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: json_schema
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -29,7 +29,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -45,21 +45,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '0.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ! '>'
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rr
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -106,25 +106,21 @@ files:
 - lib/committee/middleware/request_validation.rb
 - lib/committee/middleware/response_validation.rb
 - lib/committee/middleware/stub.rb
-- lib/committee/param_validator.rb
 - lib/committee/request_unpacker.rb
+- lib/committee/request_validator.rb
 - lib/committee/response_generator.rb
 - lib/committee/response_validator.rb
 - lib/committee/router.rb
-- lib/committee/schema.rb
 - lib/committee/test/methods.rb
-- lib/committee/validation.rb
 - lib/committee.rb
 - test/middleware/request_validation_test.rb
 - test/middleware/response_validation_test.rb
 - test/middleware/stub_test.rb
-- test/param_validator_test.rb
-- test/performance/request_validation.rb
 - test/request_unpacker_test.rb
+- test/request_validator_test.rb
 - test/response_generator_test.rb
 - test/response_validator_test.rb
 - test/router_test.rb
-- test/schema_test.rb
 - test/test/methods_test.rb
 - test/test_helper.rb
 - bin/committee-stub
@@ -154,3 +150,4 @@ signing_key:
 specification_version: 3
 summary: A collection of Rack middleware to support JSON Schema.
 test_files: []
+has_rdoc: 

data/lib/committee/param_validator.rb

@@ -1,106 +0,0 @@
-module Committee
-  class ParamValidator
-    include Validation
-
-    def initialize(params, schema, link_schema, options = {})
-      @params = params
-      @schema = schema
-      @link_schema = link_schema
-      @allow_extra = options[:allow_extra]
-    end
-
-    def call
-      detect_missing!
-      detect_extra! if !@allow_extra
-      check_data!
-    end
-
-    private
-
-    def all_keys
-      properties = @link_schema["schema"] && @link_schema["schema"]["properties"]
-      properties && properties.keys || []
-    end
-
-    def check_data!
-      return if !@link_schema["schema"] || !@link_schema["schema"]["properties"]
-
-      @link_schema["schema"]["properties"].each do |key, value|
-        # don't try to check this unless it was actually specificed
-        next unless @params.key?(key)
-
-        if value["type"] != ["array"]
-          definitions = find_definitions(value["$ref"])
-          try_match(key, @params[key], definitions)
-        else
-          # only assume one possible array definition for now
-          definitions = find_definitions(value["items"]["$ref"])
-          array_definition = definitions[0]
-          @params[key].each do |item|
-            # separate logic for a complex object that includes properties
-            if array_definition.key?("properties")
-              array_definition["properties"].each do |array_key, array_value|
-                return unless item.key?(array_key)
-
-                # @todo: this should really be recursive; only one array level is
-                # supported for now
-                item_definitions = find_definitions(array_value["$ref"])
-                try_match(array_key, item[array_key], item_definitions)
-              end
-            else
-              try_match(key, item, definitions)
-            end
-          end
-        end
-      end
-    end
-
-    def detect_extra!
-      extra = @params.keys - all_keys
-      if extra.count > 0
-        raise InvalidParams.new("Unknown params: #{extra.join(', ')}.")
-      end
-    end
-
-    def detect_missing!
-      missing = required_keys - @params.keys
-      if missing.count > 0
-        raise InvalidParams.new("Require params: #{missing.join(', ')}.")
-      end
-    end
-
-    def find_definitions(ref)
-      definition = @schema.find(ref)
-      if definition["anyOf"]
-        definition["anyOf"].map { |r| @schema.find(r["$ref"]) }
-      else
-        [definition]
-      end
-    end
-
-    def required_keys
-      (@link_schema["schema"] && @link_schema["schema"]["required"]) || []
-    end
-
-    def try_match(key, value, definitions)
-      match = false
-
-      # try to match data against any possible definition
-      definitions.each do |definition|
-        if check_type(definition["type"], value, key) &&
-          check_format(definition["format"], value, key) &&
-          check_pattern(definition["pattern"], value, key)
-          match = true
-          next
-        end
-      end
-
-      # if nothing was matched, throw error according to first definition
-      if !match && definition = definitions.first
-        check_type!(definition["type"], value, key)
-        check_format!(definition["format"], value, key)
-        check_pattern!(definition["pattern"], value, key)
-      end
-    end
-  end
-end

data/lib/committee/schema.rb

@@ -1,56 +0,0 @@
-module Committee
-  class Schema
-    include Enumerable
-
-    def initialize(data)
-      @cache = {}
-      @schema = MultiJson.decode(data)
-      manifest_regex(@schema)
-    end
-
-    def [](type)
-      find(@schema["properties"][type]['$ref'])
-    end
-
-    def each
-      @schema["properties"].each do |type, ref|
-        yield(type, find(ref['$ref']))
-      end
-    end
-
-    def find(ref)
-      cache(ref) do
-        parts = ref.split("/")
-        parts.shift if parts.first == "#"
-        pointer = @schema
-        parts.each do |p|
-          next unless pointer
-          pointer = pointer[p]
-        end
-        raise ReferenceNotFound, "Reference not found: #{ref}." if !pointer
-        pointer
-      end
-    end
-
-    private
-
-    def cache(key)
-      if @cache[key]
-        @cache[key]
-      else
-        @cache[key] = yield
-      end
-    end
-
-    def manifest_regex(schema_part)
-      schema_part["definitions"].each do |_, type_schema|
-        if type_schema.has_key?("definitions")
-          manifest_regex(type_schema)
-        end
-        if pattern = type_schema["pattern"]
-          type_schema["pattern"] = Regexp.new(pattern)
-        end
-      end
-    end
-  end
-end