roar-jsonapi 0.0.1

data/test/jsonapi/representer.rb

@@ -0,0 +1,112 @@
+Author = Struct.new(:id, :email, :name) do
+  def self.find_by(options)
+    AuthorNine if options[:id].to_s == '9'
+  end
+end
+AuthorNine = Author.new(9, '9@nine.to')
+
+Article = Struct.new(:id, :title, :author, :editor, :comments) do
+  def reviewers
+    ['Christian Bernstein']
+  end
+end
+
+Comment = Struct.new(:comment_id, :body) do
+  def self.find_by(_options)
+    new
+  end
+end
+
+class AuthorDecorator < Roar::Decorator
+  include Roar::JSON::JSONAPI.resource :authors
+
+  attributes do
+    property :email
+  end
+
+  link(:self) { "http://authors/#{represented.id}" }
+end
+
+class CommentDecorator < Roar::Decorator
+  include Roar::JSON::JSONAPI.resource(:comments, id_key: :comment_id)
+
+  attributes do
+    property :body
+  end
+
+  link(:self) { "http://comments/#{represented.comment_id}" }
+end
+
+class ArticleDecorator < Roar::Decorator
+  include Roar::JSON::JSONAPI.resource :articles
+
+  # top-level link.
+  link :self, toplevel: true do |options|
+    if options
+      "//articles?page=#{options[:page]}&per_page=#{options[:per_page]}"
+    else
+      '//articles'
+    end
+  end
+
+  meta toplevel: true do
+    property :count
+  end
+
+  attributes do
+    property :title
+  end
+
+  meta do
+    collection :reviewers
+  end
+
+  meta do
+    property :reviewer_initials, getter: ->(_) {
+      reviewers.map { |reviewer|
+        reviewer.split.map { |name| "#{name[0]}." }.join
+      }.join(', ')
+    }
+  end
+
+  # resource object links
+  link(:self) { "http://#{represented.class}/#{represented.id}" }
+
+  # relationships
+  has_one :author, class: Author, decorator: AuthorDecorator,
+    populator: ::Representable::FindOrInstantiate do # populator is for parsing, only.
+
+    relationship do
+      link(:self)     { "/articles/#{represented.id}/relationships/author" }
+      link(:related)  { "/articles/#{represented.id}/author" }
+    end
+  end
+
+  has_one :editor do
+    type :editors
+
+    relationship do
+      meta do
+        property :peer_reviewed, getter: ->(_) { false }
+      end
+    end
+
+    attributes do
+      property :email
+    end
+    # No self link for editors because we want to make sure the :links option does not appear in the hash.
+  end
+
+  has_many :comments, class: Comment, decorator: CommentDecorator,
+    populator: ::Representable::FindOrInstantiate do
+
+    relationship do
+      link(:self)     { "/articles/#{represented.id}/relationships/comments" }
+      link(:related)  { "/articles/#{represented.id}/comments" }
+
+      meta do
+        property :count, as: 'comment-count'
+      end
+    end
+  end
+end

data/test/jsonapi/resource_linkage_test.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+require 'test_helper'
+require 'roar/json/json_api'
+require 'json'
+
+class ResourceLinkageTest < MiniTest::Spec
+  class ChefDecorator < Roar::Decorator
+    include Roar::JSON::JSONAPI.resource :chefs
+
+    attributes do
+      property :name
+    end
+  end
+
+  class IngredientDecorator < Roar::Decorator
+    include Roar::JSON::JSONAPI.resource :ingredients
+
+    attributes do
+      property :name
+    end
+  end
+
+  class RecipeDecorator < Roar::Decorator
+    include Roar::JSON::JSONAPI.resource :recipes
+
+    attributes do
+      property :name
+    end
+
+    has_one   :chef,        decorator: ChefDecorator
+    has_many  :ingredients, decorator: IngredientDecorator
+
+    has_many  :reviews do
+      type :review
+
+      attributes do
+        property :text
+      end
+    end
+  end
+
+  Recipe      = Struct.new(:id, :name, :chef, :ingredients, :reviews)
+  Chef        = Struct.new(:id, :name)
+  Ingredient  = Struct.new(:id, :name)
+
+  let(:doc)               { RecipeDecorator.new(souffle).to_hash }
+  let(:doc_relationships) { doc['data']['relationships'] }
+
+  describe 'non-empty relationships' do
+    let(:souffle) {
+      Recipe.new(1, 'Cheese soufflé',
+                 Chef.new(1, 'Jamie Oliver'),
+                 [Ingredient.new(5, 'Eggs'), Ingredient.new(6, 'Gruyère')])
+    }
+
+    it 'renders a single object for non-empty to-one relationships' do
+      doc_relationships['chef'].must_equal('data'=>{ 'type' => 'chefs', 'id' => '1' })
+    end
+
+    it 'renders an array for non-empty to-many relationships' do
+      doc_relationships['ingredients'].must_equal('data' => [
+                                                    { 'type' => 'ingredients', 'id' => '5' },
+                                                    { 'type' => 'ingredients', 'id' => '6' }
+                                                  ])
+    end
+  end
+
+  describe 'empty (nil) relationships' do
+    let(:souffle) { Recipe.new(1, 'Cheese soufflé', nil, nil) }
+
+    it 'renders null for an empty to-one relationships' do
+      doc_relationships['chef'].must_equal('data' => nil)
+    end
+
+    it 'renders an empty array ([]) for empty (nil) to-many relationships' do
+      doc_relationships['ingredients'].must_equal('data' => [])
+    end
+  end
+
+  describe 'empty to-many relationships' do
+    let(:souffle) { Recipe.new(1, 'Cheese soufflé', nil, []) }
+
+    it 'renders an empty array ([]) for empty to-many relationships' do
+      doc_relationships['ingredients'].must_equal('data' => [])
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+require 'minitest/autorun'
+require 'minitest/reporters'
+Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new
+
+require 'roar/representer'
+require 'roar/json'
+require 'roar/json/json_api'
+
+require 'representable/debug'
+require 'pp'
+
+require_relative 'jsonapi/representer'
+
+require 'json_spec/configuration'
+require 'json_spec/helpers'
+require 'json_spec/exclusion'
+
+if system('colordiff', __FILE__, __FILE__)
+  MiniTest::Assertions.diff = 'colordiff -u'
+end
+
+module JsonSpec
+  extend Configuration
+
+  self.excluded_keys = []
+end
+module MiniTest::Assertions
+  def assert_equal_json(actual, expected)
+    assert_equal scrub(actual), scrub(expected)
+  end
+
+  def scrub(json, path = nil)
+    JsonSpec::Helpers.generate_normalized_json(
+      JsonSpec::Exclusion.exclude_keys(
+        JsonSpec::Helpers.parse_json(json, path)
+      )
+    ).chomp + "\n"
+  end
+end
+module Minitest::Expectations
+  infect_an_assertion :assert_equal_json, :must_equal_json
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: roar-jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Sutterer
+- Alex Coles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: roar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.10'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Object-oriented representers help you define nested JSON API documents
+  which can then be rendered and parsed using one and the same concept.
+email:
+- apotonick@gmail.com
+- alex@alexbcoles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CONTRIBUTING.md
+- Gemfile
+- ISSUE_TEMPLATE.md
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/roar/json/json_api.rb
+- lib/roar/json/json_api/declarative.rb
+- lib/roar/json/json_api/defaults.rb
+- lib/roar/json/json_api/document.rb
+- lib/roar/json/json_api/for_collection.rb
+- lib/roar/json/json_api/member_name.rb
+- lib/roar/json/json_api/meta.rb
+- lib/roar/json/json_api/options.rb
+- lib/roar/json/json_api/version.rb
+- roar-jsonapi.gemspec
+- test/jsonapi/collection_render_test.rb
+- test/jsonapi/fieldsets_options_test.rb
+- test/jsonapi/fieldsets_test.rb
+- test/jsonapi/member_name_test.rb
+- test/jsonapi/post_test.rb
+- test/jsonapi/render_test.rb
+- test/jsonapi/representer.rb
+- test/jsonapi/resource_linkage_test.rb
+- test/test_helper.rb
+homepage: http://trailblazer.to/gems/roar/jsonapi.html
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Parse and render JSON API documents using representers.
+test_files: []