jsonapi-grader 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfad176fc40e0beeb8af7c6b493172270879598b
-  data.tar.gz: '08514b2293f96171636380fa129447552863bd59'
+  metadata.gz: 36b447ba1230dd7ab8e6c1546ed576c0bf559c29
+  data.tar.gz: 9b28cc55cb678ce74d91a2e1d44ac02cc0154c14
 SHA512:
-  metadata.gz: fb55222d77f70bae46dc86b273f18229fb85b1aa9e854b293f62112c17b16b58c8062c7646248f3349f6ec2d421e487161108a8f9c0245eb6bc30016cbc49c51
-  data.tar.gz: 79135523a3199a5187e545fe8236dd537a8fdeb563cf0b0953a8b5bd788983968e44006869b779a33806fdd4b9f6f08763cb5257d0a7ae803818efd77c002432
+  metadata.gz: ab4280c8cc133cf54a8169c26b247ef290d818a0d745533a451222d8d54b4600c557c6b3e0a0d96f24bce641dc8bc3626bdc8b3c50a7ca0f0771a8ab260ffc5a
+  data.tar.gz: d20412c5bb6b74c1c1470bf5704c64c2b3b072ede3068aa8154d06360f5107ca24aae1be33a4f003c4ffcb2a210f2a48bbf0c5f2fd2034fb6555e72d35ec923b

data/bin/jsonapi-grader

@@ -2,6 +2,15 @@
 
 require 'jsonapi/grader'
 
-grader = JSONAPI::Grader.new(ARGV[0])
+grader =
+  case ARGV[0]
+  when 'serialization'
+    JSONAPI::Grader::SerializationGrader.new('scenarii_serialization.json',
+                                             implementation_dir: ARGV[1])
+  when 'server'
+    JSONAPI::Grader::ServerGrader.new(host: ARGV[1])
+  else
+    raise 'Unknown arguments'
+  end
 
 grader.grade

data/lib/jsonapi/grader/serialization_grader.rb

@@ -0,0 +1,64 @@
+require 'json'
+
+module JSONAPI
+  module Grader
+    class SerializationGrader
+      def initialize(scenarii_file = 'scenarii_serialization.json', options = {})
+        scenarii_file = File.expand_path("../../../#{scenarii_file}", __dir__)
+        @scenarii = JSON.parse(File.read(scenarii_file))
+        @implementation_dir = options[:implementation_dir]
+      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.expand_path("../../../#{scenario['file']}", __dir__)
+        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}"
+          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
+end

data/lib/jsonapi/grader/server/scenarii/empty_collection.rb

@@ -0,0 +1,45 @@
+require 'net/http'
+require 'jsonapi/grader/server/scenario'
+
+module JSONAPI
+  module Grader
+    module Server
+      class EmptyCollectionScenario < Scenario
+        def name
+          'empty_collection'
+        end
+
+        def description
+          'The endpoint /empty_collection should return an empty collection.'
+        end
+
+        def score
+          100
+        end
+
+        def required
+          true
+        end
+
+        def call(host)
+          uri = URI("#{host}/empty_collection")
+          res = Net::HTTP.start(uri.hostname, uri.port) do |http|
+            req = Net::HTTP::Get.new(uri)
+            req['Accept'] = 'application/vnd.api+json'
+
+            http.request(req)
+          end
+
+          unless res['Content-Type'] == 'application/vnd.api+json'
+            fail 'Expected Content-Type header to equal application/vnd.api+json'
+          end
+
+          body = JSON.parse(res.body)
+          unless body['data'] == []
+            fail 'Expected empty collection'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/grader/server/scenarii.rb

@@ -0,0 +1 @@
+require 'jsonapi/grader/server/scenarii/empty_collection'

data/lib/jsonapi/grader/server/scenario.rb

@@ -0,0 +1,31 @@
+module JSONAPI
+  module Grader
+    module Server
+      class Scenario
+        def call(host)
+          raise 'Not implemented'
+        end
+
+        def score
+          raise 'Not implemented'
+        end
+
+        def name
+          raise 'Not implemented'
+        end
+
+        def description
+          raise 'Not implemented'
+        end
+
+        def endpoint
+          raise 'Not implemented'
+        end
+
+        def required
+          raise 'Not implemented'
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/grader/server_grader.rb

@@ -0,0 +1,41 @@
+require 'jsonapi/grader/server/scenarii'
+
+module JSONAPI
+  module Grader
+    class ServerGrader
+      SCENARII = [Server::EmptyCollectionScenario.new]
+
+      def initialize(options = {})
+        @host = options[:host]
+      end
+
+      def grade
+        compliance = true
+        score = 0
+        max_score = 0
+        SCENARII.each do |scenario|
+          STDERR.print "Running scenario #{scenario.name}... "
+          $stderr.flush
+
+          begin
+            scenario.call(@host)
+            STDERR.puts "passed"
+            score += scenario.score
+          rescue Exception => error
+            STDERR.puts "failed"
+            STDERR.puts scenario.description
+            STDERR.puts ">>> #{error}"
+            compliance = false if scenario.required
+          end
+          max_score += scenario.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
+    end
+  end
+end

data/lib/jsonapi/grader.rb

@@ -1,63 +1,2 @@
-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
+require 'jsonapi/grader/serialization_grader'
+require 'jsonapi/grader/server_grader'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-grader
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Lucas Hosseini
@@ -17,6 +17,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- "./lib/jsonapi/grader.rb"
+- "./lib/jsonapi/grader/serialization_grader.rb"
+- "./lib/jsonapi/grader/server/scenarii.rb"
+- "./lib/jsonapi/grader/server/scenarii/empty_collection.rb"
+- "./lib/jsonapi/grader/server/scenario.rb"
+- "./lib/jsonapi/grader/server_grader.rb"
 - "./scenarii/empty_collection.json"
 - "./scenarii/null_data.json"
 - "./scenarii/simple_resource.json"
@@ -24,8 +30,7 @@ files:
 - "./scenarii/simple_resource_jsonapi_object.json"
 - "./scenarii/simple_resource_meta.json"
 - bin/jsonapi-grader
-- lib/jsonapi/grader.rb
-- scenarii.json
+- scenarii_serialization.json
 homepage: https://github.com/beauby/jsonapi-grader
 licenses:
 - MIT