granola-schema 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 201eb2e3105a257b28ded44d77e9cae937e36893
+  data.tar.gz: 2444b5b3082c5c5161c72d01d365f27f84885cd0
+SHA512:
+  metadata.gz: 2194f846f4c7cdaf6ceff6f2eefe2bc1c2d66c110f9b6b5cc2d83bb07421b825b1e282df1596ca937a6500a07159b3ad43864da75ac8dbfca1bbc17831775bed
+  data.tar.gz: a974513f758315a4ed10df2979b0decb3197b4807fc5de03804f5b89711e51fd488d2da71d4e787dedaa8071e812965c7fd8aac24782c67b6dd87c9fe04c3f94

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicolas Sanguinetti <hi@nicolassanguinetti.info>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# Granola, a JSON serializer
+
+Granola aims to provide a simple interface to generate JSON responses based on
+your application's domain models. It doesn't make assumptions about anything and
+gets out of your way. You just write plain ruby.
+
+## Example
+
+``` ruby
+class PersonSerializer < Granola::Serializer
+  def attributes
+    {
+      "name" => object.name,
+      "email" => object.email,
+      "age" => object.age
+    }
+  end
+end
+
+PersonSerializer.new(person).to_json #=> '{"name":"John Doe",...}'
+```
+
+## Install
+
+    gem install granola
+
+## JSON serialization
+
+Granola doesn't make assumptions about your code, so it shouldn't depend on a
+specific JSON backend. It uses [MultiJson][] to serialize your objects with your
+favorite backend.
+
+Try to avoid using the default, which is the `stdlib`'s pure-ruby JSON library,
+since it's slow. If in doubt, I like [Yajl][].
+
+If you want to pass options to `MultiJson` (like `pretty: true`), any keywords
+passed to `#to_json` will be forwarded to `MultiJson.dump`.
+
+[MultiJson]: https://github.com/intridea/multi_json
+[Yajl]: https://github.com/brianmario/yajl-ruby
+
+## Handling lists of models
+
+A Granola serializer can handle a list of entities of the same type by using the
+`Serializer.list` method (instead of `Serializer.new`). For example:
+
+``` ruby
+serializer = PersonSerializer.list(Person.all)
+serializer.to_json #=> '[{"name":"John Doe",...},{...}]'
+```
+
+## Rack Helpers
+
+If your application is based on rack, you have a `Rack::Response` called `res`
+in your context, and you have an `env` method that returns the Rack env hash,
+you can simply `include Granola::Rack` and you get access to the following
+interface:
+
+``` ruby
+json(person) #=> This will try to infer PersonSerializer from a Person instance
+json(person, with: AnotherSerializer)
+```
+
+*NOTE*: This works out of the box in frameworks like [Cuba][] or [Roda][]. You
+might need to provide glue code to make `res` and/or `env` available in other
+frameworks.
+
+[Cuba]: https://github.com/soveran/cuba
+[Roda]: https://github.com/jeremyevans/roda
+
+## Caching
+
+`Granola::Serializer` gives you to methods that you can implement in your
+serializers, `last_modified` and `cache_key`, that will be used to prevent
+rendering JSON at all if possible, when using the `Granola::Rack#json` helper.
+
+If your serializer implements this method, and the `env` has the appropriate
+`If-Modified-Since` or `If-None-Match` headers, the helper will automatically
+return a 304 response.
+
+Plus, it sets appropriate `ETag` and `Last-Modified` so your clients can avoid
+hitting the endpoint altogether.
+
+## License
+
+This project is shared under the MIT license. See the attached LICENSE file for
+details.

data/lib/granola/schema.rb

@@ -0,0 +1,66 @@
+require "json-schema"
+require "granola"
+
+module Granola
+  class Serializer
+    # This module adds support for JSON Schema to Granola serializers. You
+    # should define the schema for each serializer
+    module Schema
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        # Public: The schema definition for entities emitted by this serializer.
+        #
+        # Returns a Hash that complies to JSON schema.
+        def schema
+          fail NotImplementedError
+        end
+      end
+
+      # Public: Validate this serializer against it's own schema.
+      #
+      # Returns Boolean indicating whether it's valid. In case it's not, it
+      # populates the `#validation_errors` Array.
+      def valid?
+        validation_errors.clear
+        validation_errors.concat(
+          JSON::Validator.fully_validate(self.class.schema, attributes)
+        )
+        validation_errors.empty?
+      end
+
+      # Public: List any errors that arose from validating this against its
+      # schema.
+      #
+      # See #valid?
+      #
+      # Returns an Array.
+      def validation_errors
+        @validation_errors ||= []
+      end
+    end
+
+    include Schema
+  end
+
+  # Public: Schema serializer to render your JSON schemas.
+  #
+  # Example:
+  #
+  #   serializer = SchemaSerializer.new(PersonSerializer.schema)
+  #   serializer.to_json
+  class SchemaSerializer < Serializer
+    def attributes
+      {
+        "$schema".freeze => "http://json-schema.org/schema#".freeze,
+        "type".freeze => "object".freeze
+      }.merge(object)
+    end
+
+    def mime_type
+      "application/schema+json".freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: granola-schema
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicolas Sanguinetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: granola
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Handles JSON Schema support for Granola serializers.
+email:
+- contacto@nicolassanguinetti.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/granola/schema.rb
+homepage: http://github.com/foca/granola
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Granola::Schema adds JSON schema support to Granola
+test_files: []