json-schema_builder 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 082f36b316c2da4de5d21d907ed6cbf6f6856054
-  data.tar.gz: 9210568145ac172ce05396f3bb529b88e9aa82a1
+  metadata.gz: 3e166709b6daba83a54ba1774b1bbae0207b8480
+  data.tar.gz: 0af74a28bd06737381ad31e8aae3ca5f94c692f9
 SHA512:
-  metadata.gz: 92ea3b1d9739cd6f7eff349d5f67a2706a9897925089bf3ed4efcb39dae9b1a83d8b8dfafe21cfb1921f886fcd0a6e24b83792c12b6b1b23fd549519d754eea7
-  data.tar.gz: 9cf96de81566436992fa384ca0cf3be326956581d36b0beb4bd006776b5846047881e61d2521b628750f3406c0e1fd5d12c51b0ce13c3b4b84ecc706b115a980
+  metadata.gz: 9750809f3276af4d79e4eae367efbaa2a4434e25d8c07d788ab9b778569f6bf3e84581432e7890f990e53245a87c354c3a24f05ff44cf78c4a7ffca377f8556a
+  data.tar.gz: 79fbfcccad68fb29152e13886c169895ae0499ca5f6253f4cd45c6b13ec8ef28200b9eb966f69bf7e3c7c6de5d5a1574f60141cac5e374f8317ba2ebd6595496

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    json-schema_builder (0.0.2)
+    json-schema_builder (0.0.3)
       activesupport (~> 4.0, = 4.2.0.rc2)
       json-schema (~> 2.5)
 

data/README.md

@@ -1,10 +1,11 @@
 # JSON::SchemaBuilder
 
+[![Build Status](https://travis-ci.org/parrish/json-schema_builder.svg)](https://travis-ci.org/parrish/json-schema_builder)
 [![Code Climate](https://codeclimate.com/github/parrish/json-schema_builder/badges/gpa.svg)](https://codeclimate.com/github/parrish/json-schema_builder)
 [![Test Coverage](https://codeclimate.com/github/parrish/json-schema_builder/badges/coverage.svg)](https://codeclimate.com/github/parrish/json-schema_builder)
 [![Gem Version](https://badge.fury.io/rb/json-schema_builder.svg)](http://badge.fury.io/rb/json-schema_builder)
 
-Build JSON schemas with Ruby
+##### Build [JSON Schemas](http://json-schema.org) with Ruby. Validates JSON using [json-schema](https://github.com/ruby-json-schema/json-schema)
 
 ## Installation
 
@@ -24,11 +25,112 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Building schemas
+
+```ruby
+require 'json/schema_builder'
+
+class YourSchema
+  include JSON::SchemaBuilder
+
+  def schema
+    object do
+      string :name, min_length: 1, required: true
+      array :your_ids do
+        max_items 10
+        unique_items true
+        items type: :integer
+      end
+    end
+  end
+end
+
+builder = YourSchema.new
+```
+
+`builder.schema.as_json` will return a valid JSON schema:
+
+```json
+{
+  "type": "object",
+  "required": "name",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "your_ids": {
+      "type": "array",
+      "maxItems": 10,
+      "uniqueItems": true,
+      "items": { "type": "integer" }
+    }
+  }
+}
+```
+
+[More examples](https://github.com/parrish/json-schema_builder/tree/master/spec/support/examples) can be found in the specs.
+
+### Validating data against a schema
+
+`builder.schema.validate(data)` will validate your object against the schema:
+```ruby
+builder.schema.validate({ }) # => false
+builder.schema.validate name: 'Your Name' # => true
+```
+
+`builder.schema.validate!(data)` validates your object, raising an exception on failure:
+```ruby
+builder.schema.validate!({ })
+# JSON::Schema::ValidationError: The property '#/' did not contain a required property of 'name'
+
+builder.schema.validate! name: 'Your Name', your_ids: [1, 1, 2]
+# JSON::Schema::ValidationError: The property '#/your_ids' contained duplicated array values
+```
+
+`builder.schema.fully_validate(data)` validates the object and reports all invalid properties:
+```ruby
+builder.schema.fully_validate your_ids: 'fail'
+# [
+#   "The property '#/your_ids' of type String did not match the following type: array ",
+#   "The property '#/' did not contain a required property of 'name'"
+# ]
+```
+
+Fragment validation can be accomplished by specifying the schema fragment:
+```ruby
+builder.schema.validate [1], fragment: '#/properties/your_ids' # => true
+```
+
+### Configuring
+
+[json-schema](https://github.com/ruby-json-schema/json-schema) validation options can be specified in several contexts:
+
+```ruby
+# As a global default
+JSON::SchemaBuilder.configure do |opts|
+  opts.validate_schema = true
+end
+
+# As a class-level default
+YourSchema.configure do |opts|
+  opts.insert_defaults = true
+end
+
+# Or at validation
+builder.schema.validate data, strict: true, validate_schema: false
+
+# Results in
+{
+  validate_schema: false,
+  insert_defaults: true,
+  strict: true
+}
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/json-schema_builder/fork )
+1. Fork it ( https://github.com/parrish/json-schema_builder/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/json/schema_builder.rb

@@ -21,5 +21,11 @@ module JSON
     def self.default_options
       @options || { }
     end
+
+    def initialize(context = { })
+      context.each_pair do |key, value|
+        instance_variable_set "@#{ key }", value
+      end
+    end
   end
 end

data/lib/json/schema_builder/version.rb

@@ -1,5 +1,5 @@
 module JSON
   module SchemaBuilder
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/spec/integration/context_delegation_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Examples::ContextDelegation, type: :integration do
+  context 'with an admin' do
+    it_behaves_like 'a builder' do
+      let(:schema_context) do
+        {
+          user: Examples::ContextDelegation::User.new(role: :admin)
+        }
+      end
+
+      let(:expected_json) do
+        {
+          type: :object,
+          additionalProperties: false,
+          properties: {
+            name: { type: :string },
+            role: { type: :string }
+          }
+        }
+      end
+    end
+  end
+
+  context 'with a user' do
+    it_behaves_like 'a builder' do
+      let(:schema_context) do
+        {
+          user: Examples::ContextDelegation::User.new(role: :user)
+        }
+      end
+
+      let(:expected_json) do
+        {
+          type: :object,
+          additionalProperties: false,
+          properties: {
+            name: { type: :string }
+          }
+        }
+      end
+    end
+  end
+end

data/spec/integration/schema_builder_spec.rb

@@ -17,6 +17,13 @@ RSpec.describe Examples::SchemaBuilder, type: :integration do
     end
   end
 
+  describe '#initialize' do
+    it 'should assign context' do
+      instance = Examples::SchemaBuilder.new a: 1, b: 2
+      expect(instance.as_json).to eql 'a' => 1, 'b' => 2
+    end
+  end
+
   describe 'Configuration' do
     subject{ Examples::SchemaBuilder }
     after(:all) do

data/spec/support/examples/context_delegation.rb

@@ -0,0 +1,19 @@
+module Examples
+  class ContextDelegation
+    include JSON::SchemaBuilder
+    delegate :admin?, to: :@user
+
+    def example
+      object additional_properties: false do
+        string :name
+        string :role if admin?
+      end
+    end
+
+    class User < OpenStruct
+      def admin?
+        role == :admin
+      end
+    end
+  end
+end

data/spec/support/integration_helper.rb

@@ -1,6 +1,7 @@
 module IntegrationHelper
   extend RSpec::SharedContext
-  let(:schema){ described_class.new.example }
+  let(:schema_context){ { } }
+  let(:schema){ described_class.new(schema_context).example }
   let(:json){ schema.as_json }
   let(:expected_json){ { } }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json-schema_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Michael Parrish
@@ -161,6 +161,7 @@ files:
 - lib/json/schema_builder/validation.rb
 - lib/json/schema_builder/version.rb
 - spec/integration/array_definitions_spec.rb
+- spec/integration/context_delegation_spec.rb
 - spec/integration/entity_literals_spec.rb
 - spec/integration/mixed_arrays_spec.rb
 - spec/integration/mixed_objects_spec.rb
@@ -174,6 +175,7 @@ files:
 - spec/support/.keep
 - spec/support/attribute_matcher.rb
 - spec/support/examples/array_definitions.rb
+- spec/support/examples/context_delegation.rb
 - spec/support/examples/entity_literals.rb
 - spec/support/examples/mixed_arrays.rb
 - spec/support/examples/mixed_objects.rb
@@ -222,6 +224,7 @@ specification_version: 4
 summary: Build JSON schemas with Ruby
 test_files:
 - spec/integration/array_definitions_spec.rb
+- spec/integration/context_delegation_spec.rb
 - spec/integration/entity_literals_spec.rb
 - spec/integration/mixed_arrays_spec.rb
 - spec/integration/mixed_objects_spec.rb
@@ -235,6 +238,7 @@ test_files:
 - spec/support/.keep
 - spec/support/attribute_matcher.rb
 - spec/support/examples/array_definitions.rb
+- spec/support/examples/context_delegation.rb
 - spec/support/examples/entity_literals.rb
 - spec/support/examples/mixed_arrays.rb
 - spec/support/examples/mixed_objects.rb