roar-jsonapi 0.0.1

data/test/jsonapi/member_name_test.rb

@@ -0,0 +1,91 @@
+# encoding: utf-8
+
+require 'test_helper'
+require 'roar/json/json_api'
+require 'json'
+require 'jsonapi/representer'
+
+class MemberNameTest < MiniTest::Spec
+  MemberName = Roar::JSON::JSONAPI::MemberName
+
+  # http://jsonapi.org/format/#document-member-names-reserved-characters
+  UNICODE_RESERVED_CHARACTERS = [
+    "\u002B",
+    "\u002C",
+    "\u002E",
+    "\u005B",
+    "\u005D",
+    "\u0021",
+    "\u0022",
+    "\u0023",
+    "\u0024",
+    "\u0025",
+    "\u0026",
+    "\u0027",
+    "\u0028",
+    "\u0029",
+    "\u002A",
+    "\u002F",
+    "\u003A",
+    "\u003B",
+    "\u003C",
+    "\u003D",
+    "\u003E",
+    "\u003F",
+    "\u0040",
+    "\u005C",
+    "\u005E",
+    "\u0060",
+    "\u007B",
+    "\u007C",
+    "\u007D",
+    "\u007E"
+  ].freeze
+
+  describe 'strict (default)' do
+    it 'permits alphanumeric ASCII characters, hyphens' do
+      MemberName.('99 Luftballons').must_equal '99luftballons'
+      MemberName.('Artist').must_equal 'artist'
+      MemberName.('Актер').must_equal ''
+      MemberName.('おまかせ').must_equal ''
+      MemberName.('auf-der-bühne').must_equal 'auf-der-bhne'
+      MemberName.('nouvelle_interprétation').must_equal 'nouvelle-interprtation'
+    end
+
+    it 'does not permit any reserved characters' do
+      MemberName.(UNICODE_RESERVED_CHARACTERS.join).must_equal ''
+    end
+
+    it 'hyphenates underscored words' do
+      MemberName.('playtime_report').must_equal 'playtime-report'
+    end
+  end
+
+  describe 'non-strict' do
+    it 'permits alphanumeric unicode characters, hyphens, underscores and spaces' do
+      MemberName.('99 Luftballons', strict: false).must_equal '99 Luftballons'
+      MemberName.('Artist', strict: false).must_equal 'Artist'
+      MemberName.('Актер', strict: false).must_equal 'Актер'
+      MemberName.('おまかせ', strict: false).must_equal 'おまかせ'
+      MemberName.('auf-der-bühne', strict: false).must_equal 'auf-der-bühne'
+      MemberName.('nouvelle_interprétation', strict: false).must_equal 'nouvelle_interprétation'
+    end
+
+    it 'does not permit any reserved characters' do
+      MemberName.(UNICODE_RESERVED_CHARACTERS.join, strict: false).must_equal ''
+    end
+
+    it 'does not permit hyphens, underscores or spaces at beginning or end' do
+      MemberName.(' 99 Luftballons ', strict: false).must_equal '99 Luftballons'
+      MemberName.('-Artist_', strict: false).must_equal 'Artist'
+      MemberName.('_Актер', strict: false).must_equal 'Актер'
+      MemberName.(' おまかせ', strict: false).must_equal 'おまかせ'
+      MemberName.('-auf-der-bühne', strict: false).must_equal 'auf-der-bühne'
+      MemberName.('nouvelle_interprétation_', strict: false).must_equal 'nouvelle_interprétation'
+    end
+
+    it 'preserves underscored words' do
+      MemberName.('playtime_report', strict: false).must_equal 'playtime_report'
+    end
+  end
+end

data/test/jsonapi/post_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+require 'roar/json/json_api'
+require 'json'
+
+class JsonapiPostTest < MiniTest::Spec
+  describe 'Parse' do
+    let(:post_article) {
+      %({
+        "data": {
+          "type": "articles",
+          "attributes": {
+            "title": "Ember Hamster"
+          },
+          "relationships": {
+            "author": {
+              "data": {
+                "type": "people",
+                "id": "9",
+                "name": "Celsito"
+              }
+            },
+            "comments": {
+              "data": [{
+                "type": "comment",
+                "id": "2"
+              }, {
+                "type": "comment",
+                "id": "3"
+              }]
+            }
+          }
+        }
+      })
+    }
+
+    subject { ArticleDecorator.new(Article.new(nil, nil, nil, nil, [])).from_json(post_article) }
+
+    it do
+      subject.title.must_equal 'Ember Hamster'
+      subject.author.id.must_equal '9'
+      subject.author.email.must_equal '9@nine.to'
+      # subject.author.name.must_be_nil
+
+      subject.comments.must_equal [Comment.new('2'), Comment.new('3')]
+    end
+  end
+
+  describe 'Parse Simple' do
+    let(:post_article) {
+      %({
+        "data": {
+          "type": "articles",
+          "attributes": {
+            "title": "Ember Hamster"
+          }
+        }
+      })
+    }
+
+    subject { ArticleDecorator.new(Article.new(nil, nil, nil, nil, [])).from_json(post_article) }
+
+    it do
+      subject.title.must_equal 'Ember Hamster'
+    end
+  end
+
+  describe 'Parse Badly Formed Document' do
+    let(:post_article) {
+      %({"title":"Ember Hamster"})
+    }
+
+    subject { ArticleDecorator.new(Article.new(nil, nil, nil, nil, [])).from_json(post_article) }
+
+    it do
+      subject.title.must_be_nil
+    end
+  end
+end

data/test/jsonapi/render_test.rb

@@ -0,0 +1,281 @@
+require 'test_helper'
+require 'roar/json/json_api'
+require 'json'
+
+class JsonapiRenderTest < MiniTest::Spec
+  let(:article) { Article.new(1, 'Health walk', Author.new(2), Author.new('editor:1'), [Comment.new('comment:1', 'Ice and Snow'), Comment.new('comment:2', 'Red Stripe Skank')]) }
+  let(:decorator) { ArticleDecorator.new(article) }
+
+  it 'renders full document' do
+    json = decorator.to_json
+    json.must_equal_json(%({
+      "data": {
+        "id": "1",
+        "relationships": {
+          "author": {
+            "data": {
+              "id": "2",
+              "type": "authors"
+            },
+            "links": {
+              "self": "/articles/1/relationships/author",
+              "related": "/articles/1/author"
+            }
+          },
+          "editor": {
+            "data": {
+              "id": "editor:1",
+              "type": "editors"
+            },
+            "meta": {
+              "peer-reviewed": false
+            }
+          },
+          "comments": {
+            "data": [{
+              "id": "comment:1",
+              "type": "comments"
+            }, {
+              "id": "comment:2",
+              "type": "comments"
+            }],
+            "links": {
+              "self": "/articles/1/relationships/comments",
+              "related": "/articles/1/comments"
+            },
+            "meta": {
+              "comment-count": 5
+            }
+          }
+        },
+        "attributes": {
+          "title": "Health walk"
+        },
+        "type": "articles",
+        "links": {
+          "self": "http://Article/1"
+        }
+      },
+      "included": [{
+        "id": "2",
+        "type": "authors",
+        "links": {
+          "self": "http://authors/2"
+        }
+      }, {
+        "id": "editor:1",
+        "type": "editors"
+      }, {
+        "id": "comment:1",
+        "attributes": {
+          "body": "Ice and Snow"
+        },
+        "type": "comments",
+        "links": {
+          "self": "http://comments/comment:1"
+        }
+      }, {
+        "id": "comment:2",
+        "attributes": {
+          "body": "Red Stripe Skank"
+        },
+        "type": "comments",
+        "links": {
+          "self": "http://comments/comment:2"
+        }
+      }],
+      "meta": {
+        "reviewers": ["Christian Bernstein"],
+        "reviewer-initials": "C.B."
+      }
+    }))
+  end
+
+  it 'included: false suppresses compound docs' do
+    json = decorator.to_json(included: false)
+    json.must_equal_json(%({
+      "data": {
+        "id": "1",
+        "relationships": {
+          "author": {
+            "data": {
+              "id": "2",
+              "type": "authors"
+            },
+            "links": {
+              "self": "/articles/1/relationships/author",
+              "related": "/articles/1/author"
+            }
+          },
+          "editor": {
+            "data": {
+              "id": "editor:1",
+              "type": "editors"
+            },
+            "meta": {
+              "peer-reviewed": false
+            }
+          },
+          "comments": {
+            "data": [{
+              "id": "comment:1",
+              "type": "comments"
+            }, {
+              "id": "comment:2",
+              "type": "comments"
+            }],
+            "links": {
+              "self": "/articles/1/relationships/comments",
+              "related": "/articles/1/comments"
+            },
+            "meta": {
+              "comment-count": 5
+            }
+          }
+        },
+        "attributes": {
+          "title": "Health walk"
+        },
+        "type": "articles",
+        "links": {
+          "self": "http://Article/1"
+        }
+      },
+      "meta": {
+        "reviewers": ["Christian Bernstein"],
+        "reviewer-initials": "C.B."
+      }
+    }))
+  end
+
+  it 'renders additional meta information if meta option supplied' do
+    hash = decorator.to_hash(meta: {
+                               'copyright' => 'Nick Sutterer', 'reviewers' => []
+                             })
+    hash['meta']['copyright'].must_equal('Nick Sutterer')
+    hash['meta']['reviewers'].must_equal([])
+    hash['meta']['reviewer-initials'].must_equal('C.B.')
+  end
+
+  it 'does not render additonal meta information if meta option is empty' do
+    hash = decorator.to_hash(meta: {})
+    hash['meta']['copyright'].must_be_nil
+    hash['meta']['reviewers'].must_equal(['Christian Bernstein'])
+    hash['meta']['reviewer-initials'].must_equal('C.B.')
+  end
+
+  describe 'Single Resource Object with simple attributes' do
+    class DocumentSingleResourceObjectDecorator < Roar::Decorator
+      include Roar::JSON::JSONAPI.resource :articles
+
+      attributes do
+        property :title
+      end
+    end
+
+    let(:document) {
+      %({
+        "data": {
+          "id": "1",
+          "attributes": {
+            "title": "My Article"
+          },
+          "type": "articles"
+        }
+      })
+    }
+
+    let(:collection_document) {
+      %({
+        "data": [
+          {
+            "type": "articles",
+            "id": "1",
+            "attributes": {
+              "title": "My Article"
+            }
+          }
+        ]
+      })
+    }
+
+    it { DocumentSingleResourceObjectDecorator.new(Article.new(1, 'My Article')).to_json.must_equal_json document }
+    it { DocumentSingleResourceObjectDecorator.for_collection.new([Article.new(1, 'My Article')]).to_json.must_equal_json collection_document }
+  end
+
+  describe 'Single Resource Object with complex attributes' do
+    class VisualArtistDecorator < Roar::Decorator
+      include Roar::JSON::JSONAPI.resource :visual_artists
+
+      attributes do
+        property :name
+        collection :known_aliases
+        property :movement
+        collection :noteable_works
+      end
+
+      link(:self)           { "http://visual_artists/#{represented.id}" }
+      link(:wikipedia_page) { "https://en.wikipedia.org/wiki/#{represented.name}" }
+    end
+
+    Painter = Struct.new(:id, :name, :known_aliases, :movement, :noteable_works)
+
+    let(:document) {
+      %({
+        "data": {
+          "type": "visual-artists",
+          "id": "p1",
+          "attributes": {
+            "name": "Pablo Picasso",
+            "known-aliases": [
+              "Pablo Ruiz Picasso"
+            ],
+            "movement": "Cubism",
+            "noteable-works": [
+              "Kahnweiler",
+              "Guernica"
+            ]
+          },
+          "links": {
+            "self": "http://visual_artists/p1",
+            "wikipedia-page": "https://en.wikipedia.org/wiki/Pablo Picasso"
+          }
+        }
+      })
+    }
+
+    let(:collection_document) {
+      %({
+        "data": [
+          {
+            "type": "visual-artists",
+            "id": "p1",
+            "attributes": {
+              "name": "Pablo Picasso",
+              "known-aliases": [
+                "Pablo Ruiz Picasso"
+              ],
+              "movement": "Cubism",
+              "noteable-works": [
+                "Kahnweiler",
+                "Guernica"
+              ]
+            },
+            "links": {
+              "self": "http://visual_artists/p1",
+              "wikipedia-page": "https://en.wikipedia.org/wiki/Pablo Picasso"
+            }
+          }
+        ]
+      })
+    }
+
+    let(:painter) {
+      Painter.new('p1', 'Pablo Picasso', ['Pablo Ruiz Picasso'], 'Cubism',
+                  %w(Kahnweiler Guernica))
+    }
+
+    it { VisualArtistDecorator.new(painter).to_json.must_equal_json document }
+    it { VisualArtistDecorator.for_collection.new([painter]).to_json.must_equal_json collection_document }
+  end
+end