jsonapi 0.1.1.beta1

data/spec/include_directive/parser_spec.rb

@@ -0,0 +1,59 @@
+require 'jsonapi/include_directive'
+
+describe JSONAPI::IncludeDirective::Parser, '.parse_include_args' do
+  it 'handles arrays of symbols and hashes' do
+    args = [:friends,
+            comments: [:author],
+            posts: [:author,
+                    comments: [:author]]]
+    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
+    expected = {
+      friends: {},
+      comments: { author: {} },
+      posts: { author: {}, comments: { author: {} } }
+    }
+
+    expect(hash).to eq expected
+  end
+
+  it 'handles strings with spaces' do
+    str = 'friends, comments.author, posts.author, posts.comments.author'
+    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(str)
+    expected = {
+      friends: {},
+      comments: { author: {} },
+      posts: { author: {}, comments: { author: {} } }
+    }
+
+    expect(hash).to eq expected
+  end
+
+  it 'handles common prefixes in strings' do
+    args = ['friends', 'comments.author', 'posts.author',
+            'posts.comments.author']
+    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
+    expected = {
+      friends: {},
+      comments: { author: {} },
+      posts: { author: {}, comments: { author: {} } }
+    }
+
+    expect(hash).to eq expected
+  end
+
+  it 'handles an empty string' do
+    args = ''
+    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
+    expected = {}
+
+    expect(hash).to eq expected
+  end
+
+  it 'handles an empty array' do
+    args = []
+    hash = JSONAPI::IncludeDirective::Parser.parse_include_args(args)
+    expected = {}
+
+    expect(hash).to eq expected
+  end
+end

data/spec/include_directive_spec.rb

@@ -0,0 +1,47 @@
+require 'jsonapi/include_directive'
+
+describe JSONAPI::IncludeDirective, '.key?' do
+  it 'handles existing keys' do
+    str = 'posts.comments'
+    include_directive = JSONAPI::IncludeDirective.new(str)
+
+    expect(include_directive.key?(:posts)).to be_truthy
+  end
+
+  it 'handles absent keys' do
+    str = 'posts.comments'
+    include_directive = JSONAPI::IncludeDirective.new(str)
+
+    expect(include_directive.key?(:author)).to be_falsy
+  end
+
+  it 'handles wildcards' do
+    str = 'posts.*'
+    include_directive = JSONAPI::IncludeDirective.new(
+      str, allow_wildcard: true)
+
+    expect(include_directive[:posts].key?(:author)).to be_truthy
+    expect(include_directive[:posts][:author].key?(:comments)).to be_falsy
+  end
+
+  it 'handles wildcards' do
+    str = 'posts.**'
+    include_directive = JSONAPI::IncludeDirective.new(
+      str, allow_wildcard: true)
+
+    expect(include_directive[:posts].key?(:author)).to be_truthy
+    expect(include_directive[:posts][:author].key?(:comments)).to be_truthy
+  end
+end
+
+describe JSONAPI::IncludeDirective, '.to_string' do
+  it 'works' do
+    str = 'friends,comments.author,posts.author,posts.comments.author'
+    include_directive = JSONAPI::IncludeDirective.new(str)
+    expected = include_directive.to_hash
+    actual = JSONAPI::IncludeDirective.new(include_directive.to_string)
+                                        .to_hash
+
+    expect(actual).to eq expected
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,97 @@
+require 'jsonapi'
+
+describe JSONAPI, '#parse' do
+  before(:all) do
+    @author_links_hash = {
+      'self' => 'http://example.com/articles/1/relationships/author',
+      'related' => 'http://example.com/articles/1/author'
+    }
+    @author_data_hash = { 'type' => 'people', 'id' => '9' }
+    @comments_data_hash = [
+      { 'type' => 'comments', 'id' => '5' },
+      { 'type' => 'comments', 'id' => '12' }
+    ]
+    @article_relationships_hash = {
+      'author' => {
+        'links' => @author_links_hash,
+        'data' => @author_data_hash
+      },
+      'journal' => {
+        'data' => nil
+      },
+      'comments' => {
+        'links' => {
+          'self' => 'http://example.com/articles/1/relationships/comments',
+          'related' => 'http://example.com/articles/1/comments'
+        },
+        'data' => @comments_data_hash
+      }
+    }
+    @article_attributes_hash = { 'title' => 'JSON API paints my bikeshed!' }
+    @article_links_hash = { 'self' => 'http://example.com/articles/1' }
+    @data_hash = [{
+      'type' => 'articles',
+      'id' => '1',
+      'attributes' => @article_attributes_hash,
+      'links' => @article_links_hash,
+      'relationships' => @article_relationships_hash
+    }]
+    @meta_hash = {
+      'count' => '13'
+    }
+
+    @payload = {
+      'data' => @data_hash,
+      'meta' => @meta_hash
+    }
+  end
+
+  it 'works' do
+    document = JSONAPI.parse(@payload)
+
+    expect(document.meta.keys).to eq ['count']
+    expect(document.meta['count']).to eq '13'
+    expect(document.data.first.links.keys).to eq ['self']
+    expect(document.data.first.links.defined?(:self)).to be_truthy
+    expect(document.data.first.links.self.value).to eq 'http://example.com/articles/1'
+    expect(document.data.first.attributes.keys).to eq ['title']
+    expect(document.data.first.attributes.defined?(:title)).to be_truthy
+    expect(document.data.first.attributes.title).to eq 'JSON API paints my bikeshed!'
+    expect(document.data.first.relationships.keys).to eq %w(author journal comments)
+    expect(document.data.first.relationships.defined?(:author)).to be_truthy
+    expect(document.data.first.relationships.author.collection?).to be_falsy
+    expect(document.data.first.relationships.author.data.id).to eq '9'
+    expect(document.data.first.relationships.author.data.type).to eq 'people'
+    expect(document.data.first.relationships.author.links.keys).to eq ['self', 'related']
+    expect(document.data.first.relationships.author.links.defined?(:self)).to be_truthy
+    expect(document.data.first.relationships.author.links.self.value).to eq 'http://example.com/articles/1/relationships/author'
+    expect(document.data.first.relationships.author.links.defined?(:related)).to be_truthy
+    expect(document.data.first.relationships.author.links.related.value).to eq 'http://example.com/articles/1/author'
+    expect(document.data.first.relationships.defined?(:comments)).to be_truthy
+    expect(document.data.first.relationships.comments.collection?).to be_truthy
+    expect(document.data.first.relationships.comments.data.size).to eq 2
+    expect(document.data.first.relationships.comments.data[0].id).to eq '5'
+    expect(document.data.first.relationships.comments.data[0].type).to eq 'comments'
+    expect(document.data.first.relationships.comments.data[1].id).to eq '12'
+    expect(document.data.first.relationships.comments.data[1].type).to eq 'comments'
+    expect(document.data.first.relationships.comments.links.keys).to eq ['self', 'related']
+    expect(document.data.first.relationships.comments.links.defined?(:self)).to be_truthy
+    expect(document.data.first.relationships.comments.links.self.value).to eq 'http://example.com/articles/1/relationships/comments'
+    expect(document.data.first.relationships.comments.links.defined?(:related)).to be_truthy
+    expect(document.data.first.relationships.comments.links.related.value).to eq 'http://example.com/articles/1/comments'
+    expect(document.data.first.relationships.defined?(:journal)).to be_truthy
+    expect(document.data.first.relationships.journal.collection?).to be_falsy
+    expect(document.data.first.relationships.journal.data).to eq nil
+
+    expect(document.to_hash).to eq @payload
+    expect(document.data.map(&:to_hash)).to eq @data_hash
+
+    expect(document.data.first.attributes.to_hash).to eq @article_attributes_hash
+    expect(document.data.first.links.to_hash).to eq @article_links_hash
+    expect(document.data.first.relationships.to_hash).to eq @article_relationships_hash
+
+    expect(document.data.first.relationships.author.links.to_hash).to eq @author_links_hash
+    expect(document.data.first.relationships.author.data.to_hash).to eq @author_data_hash
+    expect(document.data.first.relationships.comments.data.map(&:to_hash)).to eq @comments_data_hash
+  end
+end

data/spec/resource/to_activerecord_hash_spec.rb

@@ -0,0 +1,76 @@
+require 'jsonapi'
+
+describe JSONAPI::Resource, '.to_activerecord_hash' do
+  before(:all) do
+    @payload = {
+      'data' => {
+        'type' => 'articles',
+        'id' => '1',
+        'attributes' => {
+          'title' => 'JSON API paints my bikeshed!',
+          'rating' => '5 stars'
+        },
+        'relationships' => {
+          'author' => {
+            'data' => { 'type' => 'people', 'id' => '9' }
+          },
+          'referree' => {
+            'data' => nil
+          },
+          'publishing-journal' => {
+            'data' => nil
+          },
+          'comments' => {
+            'data' => [
+              { 'type' => 'comments', 'id' => '5' },
+              { 'type' => 'comments', 'id' => '12' }
+            ]
+          }
+        }
+      }
+    }
+  end
+
+  it 'works' do
+    document = JSONAPI.parse(@payload)
+
+    options = {
+      attributes: {
+        except: [:rating]
+      },
+      relationships: {
+        only: [:author, :'publishing-journal', :comments],
+        polymorphic: [:author]
+      },
+      key_formatter: ->(x) { x.underscore }
+    }
+    actual = document.data.to_activerecord_hash(options)
+    expected = {
+      id: '1',
+      title: 'JSON API paints my bikeshed!',
+      author_id: '9',
+      author_type: 'Person',
+      publishing_journal_id: nil,
+      comment_ids: ['5', '12']
+    }
+
+    expect(actual).to eq expected
+  end
+
+  it 'whitelists all attributes/relationships by default' do
+    document = JSONAPI.parse(@payload)
+
+    actual = document.data.to_activerecord_hash
+    expected = {
+      id: '1',
+      title: 'JSON API paints my bikeshed!',
+      rating: '5 stars',
+      author_id: '9',
+      referree_id: nil,
+      :'publishing-journal_id' => nil,
+      comment_ids: ['5', '12']
+    }
+
+    expect(actual).to eq expected
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi
+version: !ruby/object:Gem::Version
+  version: 0.1.1.beta1
+platform: ruby
+authors:
+- Lucas Hosseini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Tools for handling JSON API documents
+email:
+- lucas.hosseini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jsonapi_parser.gemspec
+- lib/jsonapi.rb
+- lib/jsonapi/attributes.rb
+- lib/jsonapi/document.rb
+- lib/jsonapi/error.rb
+- lib/jsonapi/exceptions.rb
+- lib/jsonapi/include_directive.rb
+- lib/jsonapi/include_directive/parser.rb
+- lib/jsonapi/jsonapi.rb
+- lib/jsonapi/link.rb
+- lib/jsonapi/links.rb
+- lib/jsonapi/parse.rb
+- lib/jsonapi/relationship.rb
+- lib/jsonapi/relationships.rb
+- lib/jsonapi/resource.rb
+- lib/jsonapi/resource/active_record.rb
+- lib/jsonapi/resource_identifier.rb
+- lib/jsonapi/version.rb
+- spec/duplicates_spec.rb
+- spec/full_linkage_spec.rb
+- spec/include_directive/parser_spec.rb
+- spec/include_directive_spec.rb
+- spec/parser_spec.rb
+- spec/resource/to_activerecord_hash_spec.rb
+homepage: https://github.com/beauby/jsonapi
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Parse and validate JSON API documents
+test_files:
+- spec/duplicates_spec.rb
+- spec/full_linkage_spec.rb
+- spec/include_directive/parser_spec.rb
+- spec/include_directive_spec.rb
+- spec/parser_spec.rb
+- spec/resource/to_activerecord_hash_spec.rb