json-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 174874158c21768263db5ba08be05a222b6205ce
-  data.tar.gz: 8f3f7988fc68a106009353734a2ba1960e119862
+  metadata.gz: 610c75d5238c1945fe0c60fc82f3cfc5dc4e37f1
+  data.tar.gz: e2c58493d9d7097279abb64676248ed9152a67ae
 SHA512:
-  metadata.gz: 8388f07f2573ff2ee3760ab272e66b2412eec71c0e809118c29104b814302ba303cfdeb0fdb4cf1b2de4ff1ad91a34829ab3e3d628c2120a8cd64ed405f4aa47
-  data.tar.gz: b743f7c2ac9267a407751114ca56e6e53d056fe1882ae450127bf9937fb59cb8cc9e5fe2d9b3381ed1a3218e608c9dd7e4c66e00ba766eaca258c83a5f3fa7ba
+  metadata.gz: aa9880e2e534248caffa4b29e6ba276c2b03612275ed87c6003b33c15690d318058564b135900d1775803fed69f5482a8205eda0f56abe732fd845440105053e
+  data.tar.gz: 16ddd0cda8d10301ce49ec6a07a7b42f9265c25a5694c7b845ced89eb20c3b1ba65fa878f3defe3f91cf14353df016945d382a78b5336053a02cf3a8d1eda1d6

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-version
+.ruby-gemset

data/json-api.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "json-schema"
+  spec.add_dependency "json-schema"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/json/api.rb

@@ -15,9 +15,8 @@ module JSON
     end
 
     def self.validate(source, opts={})
-      json = JSON.parse(source) if source.kind_of?(String)
-
-      JSON::Validator.validate!('lib/json/api/schema.json', json)
+      source = JSON.parse(source) if source.kind_of?(String)
+      JSON::Validator.validate!(File.expand_path('api/schema.json', File.dirname(__FILE__)), source)
     end
   end
 end

data/lib/json/api/schema.json

@@ -1,3 +1,42 @@
 {
-  "$schema": "http://json-schema.org/draft-04/schema#"
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "JSON API Schema",
+  "description": "This is a schema for responses in the JSON API format. For more, see http://jsonapi.org",
+  "type": "object",
+  "patternProperties": {
+    "^(?!href$)(?!links$)(?!id$)(?!meta)(?!linked)": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "links": {
+            "type": "object"
+          }
+        },
+        "required": ["id"]
+      }
+    }
+  },
+  "properties": {
+    "meta": {
+      "type": "object"
+    },
+    "linked": {
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "links": {
+                "type": "object"
+              }
+            },
+            "required": ["id"]
+          }
+        }
+      }
+    }
+  }
 }

data/lib/json/api/version.rb

@@ -1,5 +1,5 @@
 module JSON
   module Api
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/test/acceptance_test.rb

@@ -1,7 +1,7 @@
 require 'json/api'
 
-class AcceptanceTest < MiniTest::Unit::TestCase
-  def test_homepage_id_style
+class AcceptanceIdStyleTest < MiniTest::Unit::TestCase
+  def test_homepage
     json = <<-JSON
 {
   "posts": [{
@@ -18,7 +18,119 @@ JSON
     assert JSON::Api.parse(json), "failed to parse"
   end
 
-  def test_homepage_url_style
+  def test_singular_resources
+    json = <<-JSON
+{
+  "posts": [{
+    "id": 1
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_multiple_resources
+    json = <<-JSON
+{
+  "posts": [{
+    "id": 1
+  },{
+    "id": 2
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_attributes
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase"
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_relationships
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "9",
+      "comments": [ "5", "12", "17", "20" ]
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_many_to_many_relationships
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "comments": [ "5", "12", "17", "20" ]
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_to_one_relationships
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "17"
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_compound_documents
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "9"
+    }
+  }],
+  "linked": {
+    "people": [{
+      "id": "9",
+      "name": "@d2h"
+    }]
+  }
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+end
+
+class AcceptanceUrlStyleTest < MiniTest::Unit::TestCase
+  def test_homepage
     json = <<-JSON
 {
   "posts": [{
@@ -30,6 +142,370 @@ JSON
     }
   }]
 }
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_singular_resource
+    json = <<-JSON
+{
+  "posts": [{
+    "id": 1
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_collections
+    json = <<-JSON
+{
+  "posts": [{
+    "id": 1
+  }, {
+    "id": 2
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_id
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase"
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_relationships
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "http://example.com/people/1",
+      "comments": "http://example.com/comments/5,12,17,20"
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_many_to_many
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "comments": "http://example.com/posts/1/comments"
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_to_one
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "http://example.com/people/17"
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_url_template
+    json = <<-JSON
+{
+  "links": {
+    "posts.comments": "http://example.com/posts/{posts.id}/comments"
+  },
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase"
+  }, {
+    "id": "2",
+    "title": "The Parley Letter"
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_url_template_2
+    json = <<-JSON
+{
+  "links": {
+    "posts.comments": "http://example.com/comments/{posts.comments}"
+  },
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "comments": [ "1", "2", "3", "4" ]
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_url_template_3
+    json = <<-JSON
+{
+  "links": {
+    "posts.author": "http://example.com/people/{posts.author}"
+  },
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "12"
+    }
+  }, {
+    "id": "2",
+    "title": "The Parley Letter",
+    "links": {
+      "author": "12"
+    }
+  }, {
+    "id": "3",
+    "title": "Dependency Injection is Not a Virtue",
+    "links": {
+      "author": "12"
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_compound_documents
+    json = <<-JSON
+{
+  "links": {
+    "posts.author": {
+      "href": "http://example.com/people/{posts.author}",
+      "type": "people"
+    },
+    "posts.comments": {
+      "href": "http://example.com/comments/{posts.comments}",
+      "type": "comments"
+    }
+  },
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "9",
+      "comments": [ "1", "2", "3" ]
+    }}, {
+    "id": "2",
+    "title": "The Parley Letter",
+    "links": {
+      "author": "9",
+      "comments": [ "4", "5" ]
+   }}, {
+    "id": "1",
+    "title": "Dependency Injection is Not a Virtue",
+    "links": {
+      "author": "9",
+      "comments": [ "6" ]
+    }
+  }],
+  "linked": {
+    "people": [{
+      "id": "9",
+      "name": "@d2h"
+    }],
+    "comments": [{
+      "id": "1",
+      "body": "Mmmmmakase"
+    }, {
+      "id": "2",
+      "body": "I prefer unagi"
+    }, {
+      "id": "3",
+      "body": "What's Omakase?"
+    }, {
+      "id": "4",
+      "body": "Parley is a discussion, especially one between enemies"
+    }, {
+      "id": "5",
+      "body": "The parsley letter"
+    }, {
+      "id": "6",
+      "body": "Dependency Injection is Not a Vice"
+    }]
+  }
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_compound_documents_2
+    json = <<-JSON
+{
+  "links": {
+    "posts.author": {
+      "href": "http://example.com/people/{posts.author}",
+      "type": "people"
+    },
+    "posts.comments": {
+      "href": "http://example.com/comments/{posts.comments}",
+      "type": "comments"
+    }
+  },
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "9",
+      "comments": [ "1", "2", "3" ]
+    }}, {
+    "id": "2",
+    "title": "The Parley Letter",
+    "links": {
+      "author": "9",
+      "comments": [ "4", "5" ]
+   }}, {
+    "id": "1",
+    "title": "Dependency Injection is Not a Virtue",
+    "links": {
+      "author": "9",
+      "comments": [ "6" ]
+    }
+  }],
+  "linked": {
+    "people": [{
+      "id": "9",
+      "name": "@d2h"
+    }],
+    "comments": [{
+      "href": "http://example.com/comments/1",
+      "id": "1",
+      "body": "Mmmmmakase"
+    }, {
+      "href": "http://example.com/comments/2",
+      "id": "2",
+      "body": "I prefer unagi"
+    }, {
+      "href": "http://example.com/comments/3",
+      "id": "3",
+      "body": "What's Omakase?"
+    }, {
+      "href": "http://example.com/comments/4",
+      "id": "4",
+      "body": "Parley is a discussion, especially one between enemies"
+    }, {
+      "href": "http://example.com/comments/5",
+      "id": "5",
+      "body": "The parsley letter"
+    }, {
+      "href": "http://example.com/comments/6",
+      "id": "6",
+      "body": "Dependency Injection is Not a Vice"
+    }]
+  }
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+end
+
+class AcceptanceResponseTest < MiniTest::Unit::TestCase
+  def test_created
+    json = <<-JSON
+{
+  "photos": [{
+    "id": "550e8400-e29b-41d4-a716-446655440000",
+    "href": "http://example.com/photos/12",
+    "title": "Ember Hamster",
+    "src": "http://example.com/images/productivity.png"
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_patch_1
+    json = <<-JSON
+{
+  "photos": [{
+    "id": "1",
+    "title": "Productivity",
+    "src": "http://example.com/productivity.png"
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_patch_2
+    json = <<-JSON
+{
+  "links": {
+    "photos.author": "http://example.com/people/{photos.author}"
+  },
+  "photos": [{
+    "id": "1",
+    "href": "http://example.com/photos/1",
+    "title": "Hamster",
+    "src": "images/hamster.png",
+    "links": {
+      "author": "1"
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+
+  def test_patch_3
+    json = <<-JSON
+{
+  "links": {
+    "photos.comments": "http://example.com/comments/{photos.comments}"
+  },
+  "photos": [{
+    "id": "1",
+    "href": "http://example.com/photos/1",
+    "title": "Hamster",
+    "src": "images/hamster.png",
+    "links": {
+      "comments": [ "1", "5", "12", "17" ]
+    }
+  }]
+}
 JSON
 
     assert JSON::Api.parse(json), "failed to parse"

data/test/schema_test.rb

@@ -0,0 +1,20 @@
+require 'json/api'
+
+class SchemaTest < MiniTest::Unit::TestCase
+  def test_homepage_id_style
+    json = <<-JSON
+{
+  "posts": [{
+    "id": "1",
+    "title": "Rails is Omakase",
+    "links": {
+      "author": "9",
+      "comments": [ "5", "12", "17", "20" ]
+    }
+  }]
+}
+JSON
+
+    assert JSON::Api.parse(json), "failed to parse"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -17,7 +17,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -69,6 +69,7 @@ files:
 - lib/json/api/schema.json
 - lib/json/api/version.rb
 - test/acceptance_test.rb
+- test/schema_test.rb
 - test/test_helper.rb
 homepage: http://jsonapi.org
 licenses:
@@ -96,4 +97,5 @@ specification_version: 4
 summary: A JSON API parser.
 test_files:
 - test/acceptance_test.rb
+- test/schema_test.rb
 - test/test_helper.rb