halidator 0.3.1 → 0.5.0

data/bin/halidate

@@ -1,10 +1,23 @@
 #! /usr/bin/env ruby
-
+require 'optparse'
 require_relative '../lib/halidator'
 
+options = {}
+OptionParser.new do |o|
+  o.on('-j', '--json-schema', "Validate using the HAL JSON schema") { |b| options[:json_schema] = true }
+  o.on('-h', '--help', 'Output this help and exit') { puts o; exit }
+  o.on('-d', '--debug', "Output debugging info") {$DEBUG = true}
+  o.parse!
+end
+
 input = ARGF.read
 
-hal = Halidator.new(input)
+if options[:json_schema]
+  hal = Halidator.new(input, :json_schema)
+else
+  hal = Halidator.new(input)
+end
+
 res = hal.valid?
 if true == res
   $stdout.puts "true"

data/lib/halidate/hal.json

@@ -0,0 +1,100 @@
+{
+  "id": "resource",
+  "type": "object",
+  "properties": {
+    "_links": {
+      "type": "object",
+      "title": "Hyperlink",
+      "description": "Represents a hyperlink from the containing resource to a URI.",
+      "additionalProperties": {
+        "type": [
+          {
+            "id": "link",
+            "type": "object",
+            "properties": {
+              "href": {
+                "type": "string",
+                "title": "URI of the target resource",
+                "description": "Either a URI [RFC3986] or URI Template [RFC6570] of the target resource."
+              },
+              "templated": {
+                "type": "boolean",
+                "optional": true,
+                "default": false,
+                "title": "URI Template",
+                "description": "Is true when the link object's href property is a URI Template. Defaults to false."
+              },
+              "type": {
+                "type": "string",
+                "pattern": "^(application|audio|example|image|message|model|multipart|text|video)\\/[a-zA-Z0-9!#\\$&\\.\\+-\\^_]{1,127}$",
+                "optional": true,
+                "title": "Media type indication of the target resource",
+                "description": "When present, used as a hint to indicate the media type expected when dereferencing the target resource."
+              },
+              "name": {
+                "type": "string",
+                "optional": true,
+                "title": "Secondary key",
+                "description": "When present, may be used as a secondary key for selecting link objects that contain the same relation type."
+              },
+              "profile": {
+                "type": "string",
+                "format": "uri",
+                "optional": true,
+                "title": "Additional semantics of the target resource",
+                "description": "A URI that, when dereferenced, results in a profile to allow clients to learn about additional semantics (constraints, conventions, extensions) that are associated with the target resource representation, in addition to those defined by the HAL media type and relations."
+              },
+              "title": {
+                "type": "string",
+                "optional": true,
+                "title": "Human-readable identifier",
+                "description": "When present, is used to label the destination of a link such that it can be used as a human-readable identifier (e.g. a menu entry) in the language indicated by the Content-Language header (if present)."
+              },
+              "hreflang": {
+                "type": "string",
+                "pattern": "^([a-zA-Z]{2,3}(-[a-zA-Z]{3}(-[a-zA-Z]{3}){0,2})?(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|[0-9]{3}))?(-([a-zA-Z0-9]{5,8}|[0-9][a-zA-Z0-9]{3}))*([0-9A-WY-Za-wy-z](-[a-zA-Z0-9]{2,8}){1,})*(x-[a-zA-Z0-9]{2,8})?)|(x-[a-zA-Z0-9]{2,8})|(en-GB-oed)|(i-ami)|(i-bnn)|(i-default)|(i-enochian)|(i-hak)|(i-klingon)|(i-lux)|(i-mingo)|(i-navajo)|(i-pwn)|(i-tao)|(i-tay)|(i-tsu)|(sgn-BE-FR)|(sgn-BE-NL)|(sgn-CH-DE)|(art-lojban)|(cel-gaulish)|(no-bok)|(no-nyn)|(zh-guoyu)|(zh-hakka)|(zh-min)|(zh-min-nan)|(zh-xiang)$",
+                "optional": true,
+                "title": "Language indication of the target resource [RFC5988]",
+                "description": "When present, is a hint in RFC5646 format indicating what the language of the result of dereferencing the link should be.  Note that this is only a hint; for example, it does not override the Content-Language header of a HTTP response obtained by actually following the link."
+              }
+            },
+            "additionalProperties": false
+          },
+          {
+            "type": "array",
+            "items": [
+              {
+                "$ref": "link"
+              }
+            ],
+            "uniqueItems": true,
+            "additionalProperties": false
+          }
+        ]
+      },
+      "optional": true
+    },
+    "_embedded": {
+      "type": "object",
+      "additionalProperties": {
+        "type": [
+          {
+            "$ref": "resource"
+          },
+          {
+            "type": "array",
+
+            "items": [
+              {
+                "$ref": "resource"
+              }
+            ],
+            "uniqueItems": true,
+            "additionalProperties": false
+          }
+        ]
+      },
+      "optional": true
+    }
+  }
+}

data/lib/halidate/json_schema.rb

@@ -0,0 +1,18 @@
+require 'json-schema'
+
+module Halidate
+  module JsonSchema
+    def validate_json_as_hal
+      @errors = JSON::Validator.fully_validate(@json, schema)
+      @errors.empty?
+    end
+
+    def  hal_json_schema_file
+      File.dirname(__FILE__) + "/hal.json"
+    end
+
+    def schema
+      @schema ||= File.open(hal_json_schema_file){|f| JSON.parse(f.read)}
+    end
+  end
+end

data/lib/halidate/pure_ruby.rb

@@ -0,0 +1,105 @@
+module Halidate
+  module PureRuby
+    def validate_json_as_hal
+      meets_minimal_JSON_representation? && links_all_valid? && embedded_valid?
+    end
+
+    def links_all_valid?
+      _links.all? do |k, v|
+        debug "\n\n", k, v
+
+        case v
+        when Array # is an array of links
+          v.all?{|x| link_valid?(x)}
+        else
+          link_valid?(v)
+        end
+      end
+    end
+
+    def link_valid?(link)
+      debug "    #{link}"
+
+      unless link['href']
+        errors << "no href in #{link}"
+        return false
+      end
+      unless template_valid?(link)
+        errors << "invalid template for #{link}"
+        return false
+      end
+      true
+    end
+
+    def template_valid?(link)
+      return true unless link['templated'] == true
+
+      pairs = 0
+      res = link['href'].each_char.all? do |c|
+        if '{' == c
+          pairs += 1
+          pairs == 1
+        elsif '}' == c
+          pairs -= 1
+          pairs == 0
+        else
+          true
+        end
+      end
+      res && (pairs == 0) && link['href'].include?('{')
+    end
+
+    def embedded_valid?
+      return true if _embedded.nil?
+
+      _embedded.all? do |resource_type, resource|
+        case resource
+        when Array
+          resource.all?{|x| Halidator.new(x).valid?}
+        else
+          Halidator.new(resource).valid?
+        end
+      end
+    end
+
+    def meets_minimal_JSON_representation?
+      has_links && links_has_self && self_has_href
+    end
+
+    def _embedded
+      @json['_embedded']
+    end
+
+    def _links
+      @json['_links']
+    end
+
+    def has_links
+      if _links
+        true
+      else
+        errors << '_links does not exist'
+        false
+      end
+    end
+
+    def links_has_self
+      if _links['self']
+        true
+      else
+        errors << "no self in #{_links.inspect}"
+        false
+      end
+    end
+
+    def self_has_href
+      if _links['self']['href']
+        true
+      else
+        errors << "no href in #{_links['self']}"
+        false
+      end
+    end
+
+  end
+end

data/lib/halidator.rb

@@ -1,137 +1,45 @@
 require 'json'
+require_relative './halidate/pure_ruby'
+require_relative './halidate/json_schema'
 
 class Halidator
   attr_accessor :errors
-  def initialize(hal)
+  def initialize(hal, engine = :pure_ruby)
     case hal
     when String
       @json_string = hal
+      parse_json
     else
       @json = hal
     end
-
     @errors = []
-  end
-
-  def valid?
-    result = parse_json && validate_json_as_hal
-    show_errors
-    result
+    if engine == :json_schema
+      extend Halidate::JsonSchema
+    else
+      extend Halidate::PureRuby
+    end
   end
 
   def parse_json
-    return true if @json
-
     @json = JSON.parse(@json_string)
   end
 
-  def validate_json_as_hal
-    meets_minimal_JSON_representation? && links_all_valid? && embedded_valid?
-  end
-
-  def links_all_valid?
-    _links.all? do |k, v|
-      if $DEBUG
-        puts "\n\n", k, v
-      end
-      case v
-      when Array # is an array of links
-        v.all?{|x| link_valid?(x)}
-      else
-        link_valid?(v)
-      end
-    end
+  def valid?
+    result = validate_json_as_hal
+    show_errors
+    result
   end
 
-  def link_valid?(link)
+  def debug(*str)
     if $DEBUG
-      puts "    #{link}"
+      $stderr.puts str
     end
-    unless link['href']
-      errors << "no href in #{link}"
-      return false
-    end
-    unless template_valid?(link)
-      errors << "invalid template for #{link}"
-      return false
-    end
-    true
-  end
-
-  def template_valid?(link)
-    return true unless link['templated'] == true
-
-    pairs = 0
-    res = link['href'].each_char.all? do |c|
-      if '{' == c
-        pairs += 1
-        pairs == 1
-      elsif '}' == c
-        pairs -= 1
-        pairs == 0
-      else
-        true
-      end
-    end
-    res && (pairs == 0) && link['href'].include?('{')
-  end
-
-  def embedded_valid?
-    return true if _embedded.nil?
-
-    _embedded.all? do |resource_type, resource|
-      case resource
-      when Array
-        resource.all?{|x| Halidator.new(x).valid?}
-      else
-        Halidator.new(resource).valid?
-      end
-    end
-  end
-
-  def meets_minimal_JSON_representation?
-    has_links && links_has_self && self_has_href
   end
 
   def show_errors
-    if $DEBUG
-      puts "\n---------------", "ERRORS", errors.inspect, "---------------"
-    end
-  end
-
-  def _embedded
-    @json['_embedded']
-  end
-
-  def _links
-    @json['_links']
-  end
-
-  def has_links
-    if _links
-      true
-    else
-      errors << '_links does not exist'
-      false
-    end
-  end
-
-  def links_has_self
-    if _links['self']
-      true
-    else
-      errors << "no self in #{_links.inspect}"
-      false
-    end
-  end
-
-  def self_has_href
-    if _links['self']['href']
-      true
-    else
-      errors << "no href in #{_links['self']}"
-      false
-    end
+    debug ["\nERRORS-VVVVVVVVVVVVVVVVVV",
+           *errors,
+           "ERRORS-^^^^^^^^^^^^^^^^^^"]
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: halidator
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
-dependencies: []
+date: 2012-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: A small library to validate hal+json
 email: larrick@gmail.com
 executables:
@@ -19,6 +51,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ./lib/halidator.rb
+- ./lib/halidate/hal.json
+- ./lib/halidate/pure_ruby.rb
+- ./lib/halidate/json_schema.rb
 - bin/halidate
 homepage: https://github.com/deathbob/halidator
 licenses: []