active_model_serializers_validator 0.1.3 → 0.1.4

data/README.md

@@ -1,6 +1,6 @@
 # ActiveModel::Serializer::Validator
 
-This gem adds JSON schema validations for output generated by an `ActiveModel::Serializer`.
+This gem adds JSON schema validations for the JSON output generated by an `ActiveModel::Serializer`.
 
 ## Installation
 
@@ -12,16 +12,37 @@ gem 'active_model_serializers_validator'
 
 ## Usage
 
-The gem adds one instance method and one class method to the `ActiveModel::Serializer` class, `#valid?` and `.json_schema`:
+The gem adds two instance methods (`#valid?` and `#errors`) and one class method (`.json_schema`) to the `ActiveModel::Serializer` class.
+
+### A JSON schema
+
+```json
+{
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-03/schema",
+  "id": "#",
+  "required": false,
+  "additionalProperties": false,
+  "properties": {
+    "favorite_number": {
+      "type": "integer",
+      "id": "favorite_number",
+      "required": true
+    },
+  }
+}
+```
+
+### A serializer
 
 ```ruby
 class MySerializer < ActiveModel::Serializer
   json_schema '/path/to/my/schema.jsonschema'
-
-  attribute :foo
+  attribute :favorite_number
 end
 
-serializer = MySerializer.new(OpenStruct.new(foo: 'bla'))
+object = OpenStruct.new(favorite_number: 'what?')
+serializer = MySerializer.new(object)
 
 serializer.valid?
 # => false
@@ -30,10 +51,6 @@ serializer.errors
 # => [The property '#/foo' of type String did not match the following type: integer in schema /path/to/my/schema.jsonschema]
 ```
 
-## Todo
-
-* Add more features! :smile:
-
 ## License
 
 `ActiveModel::Serializer::Validator` is © 2013 [Mirego](http://www.mirego.com) and may be freely distributed under the [New BSD license](http://opensource.org/licenses/BSD-3-Clause).  See the [`LICENSE.md`](https://github.com/mirego/active_model_serializers_validator/blob/master/LICENSE.md) file.

data/active_model_serializers_validator.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'An extension to ActiveModel::Serializer that validates serializers output against a JSON schema'
   spec.summary       = 'An extension to ActiveModel::Serializer that validates serializers output against a JSON schema'
   spec.homepage      = 'https://github.com/mirego/active_model_serializers_validator'
-  spec.license       = 'New BSD'
+  spec.license       = 'BSD 3-Clause'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/active_model/serializer/validator/version.rb

@@ -1,7 +1,7 @@
 module ActiveModel
   class Serializer
     module Validator
-      VERSION = '0.1.3'
+      VERSION = '0.1.4'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2013-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,7 +148,7 @@ files:
 - spec/validator_spec.rb
 homepage: https://github.com/mirego/active_model_serializers_validator
 licenses:
-- New BSD
+- BSD 3-Clause
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -161,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 199562626635737587
+      hash: 1033799192214177102
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 199562626635737587
+      hash: 1033799192214177102
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23