hal_spec 0.0.1 → 1.0.0

data/features/equivalence.feature

@@ -1,11 +1,30 @@
 Feature: Equivalence 
-  Scenario: Complete HAL
+  Background:
     Given the HAL is:
       """
-        {"_links": {"self": {"href": "/lol"}}}
+      {
+      "_links": {"self": {"name":"namen", "href": "/lol"}}
+      ,"_embedded": {"users": [], "pages": []}, "id": 666
+      }
       """
+
+  Scenario: Complete HAL
     When I get the HAL
     Then the HAL response should be:
       """
-        {"_links": {"self": {"href": "/lol"}}}
+      {
+        "id": 666
+        /*it has embedded things!*/
+        ,"_embedded": {
+          "pages": []
+         ,"users": []
+        }
+        ,"_links": {
+          "self": {
+            /*lol is funny*/
+             "href": "/lol"
+             ,"name": "namen"
+          }
+        }
+      }
       """

data/features/step_definitions/steps.rb

@@ -9,7 +9,7 @@ def app
 end
 
 Given "the HAL is:" do |provided_hal|
-  @hal = provided_hal
+  @hal = provided_hal.gsub(/\s+/, "")
 end
 
 When "I get the HAL" do

data/hal_spec.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |gem|
   gem.version       = HalSpec::VERSION
 
   gem.add_dependency "halidator", "~> 0.5"
+  gem.add_dependency "json_spec", "~> 1.1"
 
   gem.add_development_dependency "rspec", "~> 2.0"
   gem.add_development_dependency "cucumber"

data/lib/hal_spec/cucumber.rb

@@ -1,11 +1,9 @@
 require File.expand_path("../../hal_spec", __FILE__)
-World(HalSpec::Matchers)
+World(HalSpec::Matchers, JsonSpec::Matchers)
 
-Then /the HAL response should be:/ do |whole_or_partial_hal|
-
-  json_body = JSON.parse(last_response.body)
-  json_body.should_not be_nil
-  json_body.should == (JSON.parse(whole_or_partial_hal))
-  last_response.should have_a_valid_hal_content_type
-  last_response.should be_valid_hal
+Then /the HAL response should be:/ do |expected_hal|
+  expected_hal.gsub(/\s+/, " ").should be_valid_hal
+  last_response.body.should be_json_eql(expected_hal)
+  last_response.headers.should have_a_valid_hal_content_type
+  last_response.body.should be_valid_hal
 end

data/lib/hal_spec/matchers/be_valid_hal.rb

@@ -1,10 +1,9 @@
 module HalSpec
   module Matchers
     module BeValidHal 
-      def has_valid_body?(response)
-        return false unless (response.respond_to?(:body) and !response.body.nil?)
-        JSON.parse(response.body) rescue return false
-        return Halidator.new(response.body).valid?
+      def is_valid_hal?(str)
+        JSON.parse(str) rescue return false
+        return Halidator.new(str).valid?
       end
     end
   end

data/lib/hal_spec/matchers/have_a_valid_hal_content_type.rb

@@ -1,13 +1,13 @@
 module HalSpec
   module Matchers
     module HaveAValidHalContentType
-      def has_valid_content_type?(response)
-        response.respond_to?(:headers) or return false
-        response.headers.include?("Content-Type") or return false
+      def has_valid_content_type?(headers)
+        return false if headers.nil?
+        return false unless headers.include?("Content-Type")
         %w(
           application/vnd.hal+json
           application/hal+json
-        ).include?(response.headers["Content-Type"])
+        ).include?(headers["Content-Type"])
       end
     end
   end

data/lib/hal_spec/matchers.rb

@@ -8,14 +8,14 @@ module HalSpec
     include HalSpec::Matchers::BeValidHal
 
     matcher :have_a_valid_hal_content_type do 
-      match do |response|
-        has_valid_content_type?(response)
+      match do |headers|
+        has_valid_content_type?(headers)
       end
     end
 
     matcher :be_valid_hal do 
-      match do |response|
-        has_valid_body?(response)
+      match do |body|
+        is_valid_hal?(body)
       end
     end
   end

data/lib/hal_spec/version.rb

@@ -1,3 +1,3 @@
 module HalSpec
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/hal_spec.rb

@@ -1,4 +1,5 @@
 require 'rspec'
+require 'json_spec'
 require 'halidator'
 require "hal_spec/version"
 require "hal_spec/matchers"

data/spec/hal_spec/matchers/be_valid_hal_spec.rb

@@ -1,82 +1,75 @@
 require 'spec_helper'
-require 'ostruct'
 require 'json'
 
-def Hal(body)
-  OpenStruct.new(body: JSON.dump(body))
+def dump(body)
+  JSON.dump(body)
 end
 
 describe HalSpec::Matchers::BeValidHal do
   let(:minimal_hal){ {_links: {self: {href: "/some/url"}}} }
 
-  context "response prerequisites" do
-    it "should match responses with documented json" do
-      OpenStruct.new(
-        body: '/*this is hal*/{"_links": /*documents are fun!*/{"self": {"href": "/url"}}}'
-      ).should be_valid_hal
+  context "string prerequisites" do
+    it "should match json with comments" do
+      '/*this is hal*/{"_links": /*documents are fun!*/{"self": {"href": "/url"}}}'.should be_valid_hal
     end
 
     it "should not match responses without bodies" do
-      OpenStruct.new(bodie: "lel").should_not be_valid_hal
-      OpenStruct.new(body: nil).should_not be_valid_hal
-    end
-
-    it "should not match responses without json bodies" do
-      OpenStruct.new(body: "Yo dawg").should_not be_valid_hal
+      "li".should_not be_valid_hal
+       nil.should_not be_valid_hal
     end
   end
 
   context "link validation" do
     it "should match a document with only links" do
-      Hal(minimal_hal).should be_valid_hal
+      dump(minimal_hal).should be_valid_hal
     end
 
     it "should match a document with valid links other than self" do
       json = minimal_hal.dup
       json[:_links].merge!({search: {href: "/search/{q}", templated: true}})
-      Hal(json).should be_valid_hal
+      dump(json).should be_valid_hal
     end
 
     it "should match a document with valid links in arrays" do
       json = minimal_hal.dup
       json[:_links].merge!({users: [{href: "/users/42"}]})
-      Hal(json).should be_valid_hal
+      dump(json).should be_valid_hal
     end
 
     it "should match a document with templated links in arrays" do
       json = minimal_hal.dup
       json[:_links].merge!({sortings: [{href: "/sort/{dir}", templated: true}]})
-      Hal(json).should be_valid_hal
+      dump(json).should be_valid_hal
     end
 
     it "should not match a document without links" do
-      Hal({no_links: {self: {href: "/nope"}}}).should_not be_valid_hal
+      dump({no_links: {self: {href: "/nope"}}}).should_not be_valid_hal
     end
 
     it "should not match a document without the self link" do
-      Hal({_links: {lel: {href: "/pah"}}}).should_not be_valid_hal
+      dump({_links: {lel: {href: "/pah"}}}).should_not be_valid_hal
     end
 
     it "should not match a document with invalid link values for self" do
-      Hal({_links: {self: {breh: "/brah"}}}).should_not be_valid_hal
+      dump({_links: {self: {breh: "/brah"}}}).should_not be_valid_hal
     end
 
     it "should not match a document with invalid links for other rels" do
       json = minimal_hal.dup
       json[:_links].merge!({search:  "/search/{q}", templated: true})
-      Hal(json).should_not be_valid_hal
+      dump(json).should_not be_valid_hal
     end
 
     it "should not match a document with too many self rels" do
       json = minimal_hal.dup
       json[:_links].merge!({users: [{self: {href: "/users/4"}},{self: {href: "/users/2"}}]})
-      Hal(json).should_not be_valid_hal
+      dump(json).should_not be_valid_hal
     end
 
     it "should not match a document with no href key in arrays" do
       json = minimal_hal.dup
       json[:_links].merge!({users: [{bref: "/lel"}]})
-      Hal(json).should_not be_valid_hal
+      dump(json).should_not be_valid_hal
     end
 
     it "should not match a document with invalid templates in arrays" do
@@ -91,15 +84,15 @@ describe HalSpec::Matchers::BeValidHal do
 
   context "resource validation" do
     it "should match a document with embedded resources as an object" do
-      Hal({_embedded: {resources: []}}.merge(minimal_hal)).should be_valid_hal
+      dump({_embedded: {resources: []}}.merge(minimal_hal)).should be_valid_hal
     end
 
     it "should match a document with valid embedded resources" do
-      Hal({_embedded: {resources: 2.times.collect{minimal_hal}}}.merge(minimal_hal)).should be_valid_hal
+      dump({_embedded: {resources: 2.times.collect{minimal_hal}}}.merge(minimal_hal)).should be_valid_hal
     end
 
     it "should match a document with non-array valid embedded resources" do
-      Hal({
+      dump({
         _embedded: {user: minimal_hal}
       }.merge(minimal_hal)).should be_valid_hal
     end
@@ -111,11 +104,11 @@ describe HalSpec::Matchers::BeValidHal do
           user: [{_embedded: {stuff: [valid_hal]}}.merge(valid_hal)]
         }
       }.merge(minimal_hal)
-      Hal(json).should be_valid_hal
+      dump(json).should be_valid_hal
     end
 
     it "should not match a document with deeply nested invalid resources" do
-      Hal({
+      dump({
         _embedded: {
           user: [{
             _embedded: {stuff: [{_links: {self: {lel: "/lol"}}}]}

data/spec/hal_spec/matchers/have_a_valid_hal_content_type_spec.rb

@@ -4,23 +4,23 @@ require 'ostruct'
 describe HalSpec::Matchers::HaveAValidHalContentType do
   it "matches standard hal content types" do
     response = OpenStruct.new(headers: {"Content-Type" => "application/vnd.hal+json"})
-    response.should have_a_valid_hal_content_type
+    response.headers.should have_a_valid_hal_content_type
 
     response = OpenStruct.new(headers: {"Content-Type" => "application/hal+json"})
-    response.should have_a_valid_hal_content_type
+    response.headers.should have_a_valid_hal_content_type
   end
 
   it "doesn't match invalid hal content types" do
     response = OpenStruct.new(headers: {"Content-Type" => "application/json"})
-    response.should_not have_a_valid_hal_content_type
+    response.headers.should_not have_a_valid_hal_content_type
   end
 
   it "doesn't match responses without content types" do
     response = OpenStruct.new(headers: {})
-    response.should_not have_a_valid_hal_content_type
+    response.headers.should_not have_a_valid_hal_content_type
 
     response = OpenStruct.new
-    response.should_not have_a_valid_hal_content_type
+    response.headers.should_not have_a_valid_hal_content_type
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal_spec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: json_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement