jsonapi-grader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfad176fc40e0beeb8af7c6b493172270879598b
+  data.tar.gz: '08514b2293f96171636380fa129447552863bd59'
+SHA512:
+  metadata.gz: fb55222d77f70bae46dc86b273f18229fb85b1aa9e854b293f62112c17b16b58c8062c7646248f3349f6ec2d421e487161108a8f9c0245eb6bc30016cbc49c51
+  data.tar.gz: 79135523a3199a5187e545fe8236dd537a8fdeb563cf0b0953a8b5bd788983968e44006869b779a33806fdd4b9f6f08763cb5257d0a7ae803818efd77c002432

data/bin/jsonapi-grader

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'jsonapi/grader'
+
+grader = JSONAPI::Grader.new(ARGV[0])
+
+grader.grade

data/lib/jsonapi/grader.rb

@@ -0,0 +1,63 @@
+require 'json'
+
+module JSONAPI
+  class Grader
+    def initialize(implementation_dir)
+      @implementation_dir = implementation_dir
+      scenarii_file = File.dirname(__FILE__) + '/../../scenarii.json'
+      @scenarii = JSON.parse(File.read(scenarii_file))
+    end
+
+    def grade
+      compliance = true
+      score = 0
+      max_score = 0
+      @scenarii.each do |scenario|
+        current_score = score_scenario(scenario)
+        compliance = false if scenario['required'] && current_score == 0
+        max_score += scenario['score']
+        score += current_score
+      end
+
+      STDERR.puts "Compliance: #{compliance}"
+      score_percent = (100.0 * score / max_score).round(2)
+      STDERR.puts "Score: #{score} / #{max_score} (#{score_percent}%)"
+
+      score
+    end
+
+    private
+
+    def score_scenario(scenario)
+      document_file = File.dirname(__FILE__) + "/../../#{scenario['file']}"
+      reference_document = normalize(JSON.parse(File.read(document_file)))
+      implementation = "#{@implementation_dir}/#{scenario['name']}"
+      STDERR.print "Running scenario #{scenario['name']}... "
+      $stderr.flush
+      unless File.exists?(implementation)
+        STDERR.puts "not implemented"
+        return 0
+      end
+
+      actual_document = normalize(JSON.parse(`#{implementation}`))
+      if reference_document == actual_document
+        STDERR.puts "passed"
+        return scenario['score']
+      else
+        STDERR.puts "failed"
+        STDERR.puts "Expected: #{reference_document}"
+        STDERR.puts "Got: #{actual_document}"
+        $stderr.flush
+        return 0
+      end
+    end
+
+    def normalize(document)
+      return document unless document.key?('included')
+
+      document['included'].sort do |a, b|
+        [a['type'], a['id']] <=> [b['type'], b['id']]
+      end
+    end
+  end
+end

data/scenarii.json

@@ -0,0 +1,38 @@
+[
+    {
+        "name": "null_data",
+        "file": "scenarii/null_data.json",
+        "score": 100,
+        "required": true
+    },
+    {
+        "name": "empty_collection",
+        "file": "scenarii/empty_collection.json",
+        "score": 100,
+        "required": true
+    },
+    {
+        "name": "simple_resource",
+        "file": "scenarii/simple_resource.json",
+        "score": 100,
+        "required": true
+    },
+    {
+        "name": "simple_resource_attributes",
+        "file": "scenarii/simple_resource_attributes.json",
+        "score": 100,
+        "required": true
+    },
+    {
+        "name": "simple_resource_meta",
+        "file": "scenarii/simple_resource_meta.json",
+        "score": 10,
+        "required": false
+    },
+    {
+        "name": "simple_resource_jsonapi_object",
+        "file": "scenarii/simple_resource_jsonapi_object.json",
+        "score": 10,
+        "required": false
+    }
+]

data/scenarii/empty_collection.json

@@ -0,0 +1,3 @@
+{
+    "data": []
+}

data/scenarii/null_data.json

@@ -0,0 +1,3 @@
+{
+    "data": null
+}

data/scenarii/simple_resource.json

@@ -0,0 +1,6 @@
+{
+    "data": {
+        "id": "1",
+        "type": "articles"
+    }
+}

data/scenarii/simple_resource_attributes.json

@@ -0,0 +1,10 @@
+{
+    "data": {
+        "id": "1",
+        "type": "articles",
+        "attributes": {
+            "title": "json:api",
+            "content": "I love it."
+        }
+    }
+}

data/scenarii/simple_resource_jsonapi_object.json

@@ -0,0 +1,12 @@
+{
+    "data": {
+        "id": "1",
+        "type": "articles"
+    },
+    "jsonapi": {
+        "version": "1.0",
+        "meta": {
+            "compliant": "true"
+        }
+    }
+}

data/scenarii/simple_resource_meta.json

@@ -0,0 +1,9 @@
+{
+    "data": {
+        "id": "1",
+        "type": "articles"
+    },
+    "meta": {
+        "compliant": "true"
+    }
+}

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-grader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lucas Hosseini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-02 00:00:00.000000000 Z
+dependencies: []
+description: Ensure compliance of your JSON API library.
+email: lucas.hosseini@gmail.com
+executables:
+- jsonapi-grader
+extensions: []
+extra_rdoc_files: []
+files:
+- "./scenarii/empty_collection.json"
+- "./scenarii/null_data.json"
+- "./scenarii/simple_resource.json"
+- "./scenarii/simple_resource_attributes.json"
+- "./scenarii/simple_resource_jsonapi_object.json"
+- "./scenarii/simple_resource_meta.json"
+- bin/jsonapi-grader
+- lib/jsonapi/grader.rb
+- scenarii.json
+homepage: https://github.com/beauby/jsonapi-grader
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Grade jsonapi.org implementations.
+test_files: []