active_model_serializers_validator 0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2013, Mirego
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the Mirego nor the names of its contributors may
+  be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,41 @@
+# ActiveModel::Serializer::Validator
+
+This gem adds JSON schema validations for output generated by an `ActiveModel::Serializer`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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`:
+
+```ruby
+class MySerializer < ActiveModel::Serializer
+  json_schema '/path/to/my/schema.jsonschema'
+
+  attribute :foo
+  attribute :bar
+end
+
+serializer = MySerializer.new(OpenStruct.new(foo: 'bla'))
+serializer.valid?
+# => false
+```
+
+## Todo
+
+* Provide more details as to why the validation failed.
+* 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/MCUIImageAdvanced/blob/master/LICENSE.md) file.
+
+## About Mirego
+
+Mirego is a team of passionate people who believe that work is a place where you can innovate and have fun. We proudly built mobile applications for iPhone, iPad, Android, Blackberry, Windows Phone and Windows 8.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/active_model_serializers_validator.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model/serializer/validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_model_serializers_validator'
+  spec.version       = ActiveModel::Serializer::Validator::VERSION
+  spec.authors       = ['Rémi Prévost']
+  spec.email         = ['rprevost@mirego.com']
+  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       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency "activesupport", '>= 3.0.0'
+  spec.add_dependency "active_model_serializers", '~> 0.8'
+  spec.add_dependency "json-schema", '~> 1.1'
+end

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

@@ -0,0 +1,31 @@
+module ActiveModel
+  class Serializer
+    module Validator
+      module Mixin
+        extend ActiveSupport::Concern
+
+        # Validate the rendered data against a JSON schema file
+        def valid_against_schema?(schema)
+          JSON::Validator.validate(schema, self.to_json)
+        end
+
+        # Return whether the serializer output is valid
+        def valid?
+          valid_against_schema?(self.class.json_schema)
+        end
+
+        module ClassMethods
+          # Set the JSON schema to use for this class
+          def json_schema(value = nil)
+            @_json_schema ||= begin
+              superclass.primary_key if superclass.respond_to?(:json_schema)
+            end
+
+            return @_json_schema unless value
+            @_json_schema = value
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module ActiveModel
+  class Serializer
+    module Validator
+      VERSION = '0.1'
+    end
+  end
+end

data/lib/active_model/serializer/validator.rb

@@ -0,0 +1,5 @@
+require 'json-schema'
+require 'active_model/serializer/validator'
+
+# Inject the mixin in the ActiveModel::Serializer class
+ActiveModel::Serializer.send :include, ActiveModel::Serializer::Validator::Mixin

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: active_model_serializers_validator
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Rémi Prévost
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: An extension to ActiveModel::Serializer that validates serializers output
+  against a JSON schema
+email:
+- rprevost@mirego.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- active_model_serializers_validator.gemspec
+- lib/active_model/serializer/validator.rb
+- lib/active_model/serializer/validator/mixin.rb
+- lib/active_model/serializer/validator/version.rb
+homepage: https://github.com/mirego/active_model_serializers_validator
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1061494785049302290
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1061494785049302290
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An extension to ActiveModel::Serializer that validates serializers output
+  against a JSON schema
+test_files: []