active_model_serializers_validator 0.1.1 → 0.1.2

data/.rspec

@@ -0,0 +1 @@
+--colour

data/README.md

@@ -34,8 +34,15 @@ serializer.valid?
 
 ## 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.
+`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.
 
 ## 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.
+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](http://mirego.com/en/iphone-app-development/ "iPhone application development"),
+[iPad](http://mirego.com/en/ipad-app-development/ "iPad application development"),
+[Android](http://mirego.com/en/android-app-development/ "Android application development"),
+[Blackberry](http://mirego.com/en/blackberry-app-development/ "Blackberry application development"),
+[Windows Phone](http://mirego.com/en/windows-phone-app-development/ "Windows Phone application development") and
+[Windows 8](http://mirego.com/en/windows-8-app-development/ "Windows 8 application development").

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = "spec/**/*_spec.rb"
+end

data/active_model_serializers_validator.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'json', '~> 1.7.7'
 
   spec.add_dependency "activesupport", '>= 3.0.0'
   spec.add_dependency "active_model_serializers", '~> 0.8'

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

@@ -4,14 +4,14 @@ module ActiveModel
       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)
+        included do
+          attr_reader :errors
         end
 
         # Return whether the serializer output is valid
         def valid?
-          valid_against_schema?(self.class.json_schema)
+          @errors = self.class.valid_against_schema?(self.class.json_schema, self)
+          @errors.empty?
         end
 
         module ClassMethods
@@ -24,6 +24,12 @@ module ActiveModel
             return @_json_schema unless value
             @_json_schema = value
           end
+
+          # Validate the rendered data against a JSON schema file and
+          # return an errors array
+          def valid_against_schema?(schema, serializer)
+            JSON::Validator.fully_validate(schema, serializer.to_json)
+          end
         end
       end
     end

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

@@ -1,7 +1,7 @@
 module ActiveModel
   class Serializer
     module Validator
-      VERSION = '0.1.1'
+      VERSION = '0.1.2'
     end
   end
 end

data/lib/active_model_serializers_validator.rb

@@ -1,4 +1,7 @@
 require 'json-schema'
+require 'active_support'
+require 'active_support/core_ext/object/to_json'
+require 'active_model/serializer'
 require 'active_model/serializer/validator/mixin'
 require 'active_model/serializer/validator/version'
 

data/spec/fixtures/product.jsonschema

@@ -0,0 +1,27 @@
+{
+  "name":"Product",
+  "properties":{
+    "id":{
+      "type":"number",
+      "description":"Product identifier",
+      "required":true
+    },
+    "name":{
+      "description":"Name of the product",
+      "type":"string",
+      "required":true
+    },
+    "price":{
+      "required":true,
+      "type": "number",
+      "minimum":0,
+      "required":true
+    },
+    "tags":{
+      "type":"array",
+      "items":{
+        "type":"string"
+      }
+    }
+  }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require "rspec"
+require 'ostruct'
+require "active_model_serializers_validator"
+
+# Require everything in `spec/support`
+Dir[File.expand_path('../../spec/support/**/*.rb', __FILE__)].map(&method(:require))
+
+# Configure RSpec
+RSpec.configure do |config|
+  # Modules
+  config.include Fixtures
+  config.include Serializers
+
+  # Hooks
+  config.before(:suite) do
+    class OpenStruct
+      def read_attribute_for_serialization(attribute)
+        self.send(attribute)
+      end
+    end
+  end
+end

data/spec/support/macros/fixtures.rb

@@ -0,0 +1,5 @@
+module Fixtures
+  def product_schema
+    File.expand_path("../../../fixtures/product.jsonschema", __FILE__)
+  end
+end

data/spec/support/macros/serializers.rb

@@ -0,0 +1,5 @@
+module Serializers
+  def try_remove_const(const)
+    Object.instance_eval { remove_const(const) } if Object.const_defined?(const)
+  end
+end

data/spec/validator_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe ActiveModel::Serializer::Validator do
+  describe :valid? do
+    subject { ActiveModel::Serializer.new(OpenStruct.new(:foo => 'bar')) }
+    before { ActiveModel::Serializer.stub(:valid_against_schema?).and_return(stubbed_validation) }
+
+    context 'with empty errors' do
+      let(:stubbed_validation) { [] }
+      it { should be_valid }
+    end
+
+    context 'with errors' do
+      let(:stubbed_validation) { ['First error', 'Second error'] }
+      it { should_not be_valid }
+    end
+  end
+
+  describe :valid_against_schema? do
+    before do
+      try_remove_const(:ProductSerializer)
+
+      ProductSerializer = Class.new(ActiveModel::Serializer) do
+        self.root = false
+        attributes :id, :name, :price, :tags
+      end
+    end
+
+    subject { ActiveModel::Serializer.valid_against_schema?(product_schema, serializer) }
+    let(:serializer) { ProductSerializer.new(serializable) }
+      let(:schema) { product_schema }
+
+    context 'without validaton errors' do
+      let(:serializable) { OpenStruct.new(:id => 4, :name => "Widget", :price => 1200, :tags => %w(foo bar baz)) }
+      it { should be_empty }
+    end
+
+    context 'with validaton errors' do
+      let(:serializable) { OpenStruct.new(:id => 4, :price => 1200, :tags => %w(foo bar baz)) }
+      it { should_not be_empty }
+      its(:length) { should eql 1 }
+    end
+  end
+
+  describe :json_schema do
+    # TODO
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_serializers_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-24 00:00:00.000000000 Z
+date: 2013-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +132,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.md
 - README.md
@@ -108,6 +141,11 @@ files:
 - lib/active_model/serializer/validator/mixin.rb
 - lib/active_model/serializer/validator/version.rb
 - lib/active_model_serializers_validator.rb
+- spec/fixtures/product.jsonschema
+- spec/spec_helper.rb
+- spec/support/macros/fixtures.rb
+- spec/support/macros/serializers.rb
+- spec/validator_spec.rb
 homepage: https://github.com/mirego/active_model_serializers_validator
 licenses:
 - MIT
@@ -123,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4488155984166629384
+      hash: -3953196887841094679
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4488155984166629384
+      hash: -3953196887841094679
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -140,4 +178,9 @@ signing_key:
 specification_version: 3
 summary: An extension to ActiveModel::Serializer that validates serializers output
   against a JSON schema
-test_files: []
+test_files:
+- spec/fixtures/product.jsonschema
+- spec/spec_helper.rb
+- spec/support/macros/fixtures.rb
+- spec/support/macros/serializers.rb
+- spec/validator_spec.rb