jsonapi 0.1.1.beta2 → 0.1.1.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ced99ef009aee2a4a5473acbc9ee8dc8c53d14b0
-  data.tar.gz: a9b87f7ef84013e382df467138ebc723790d27d9
+  metadata.gz: 988edc569bb3ddbea483619be6102a7126e4a8d4
+  data.tar.gz: 784cbf00227eb548ae79feb605b410f9512ba80f
 SHA512:
-  metadata.gz: 1b0c8e23de976228e9a08d350d23459d49159422b329c72487261785490f548fa70a14556985d06cb2070c184bbebd1aad0a45505bd482e6ff3710111298f343
-  data.tar.gz: 6f85d5fe158aa995aa4059166e1143dd7826ddce93d0968aea9e1b7c8f289f4cfc24ab9c9a9c0733d44293d4a5d7df2242ab173e21bc16b0c7552d77493e3876
+  metadata.gz: 907eb805965a524ff2ed45729f45d68011589a3de38bda36703425f02df526441e3d4ae49f5cb2d7005b3964ee986400e74a88643ec211456232df0d826ed79e
+  data.tar.gz: a4cf7fbebae712a81c0c961f81c8a14cf9c49860fcbac14b463d969314883abe1758de2b053db2ae7fafb7e1c788d701d922b7b1d46c68285e916430800ee97e

data/README.md

@@ -1,133 +1,31 @@
 # jsonapi
-Ruby gem for parsing/validating [JSON API](http://jsonapi.org) documents.
+Ruby gem for parsing/rendering [JSON API](http://jsonapi.org) documents.
 
 ## Installation
-
-Add the following to your application's Gemfile:
 ```ruby
+# In Gemfile
 gem 'jsonapi'
 ```
-And then execute:
+then
 ```
 $ bundle
 ```
-Or install it manually as:
+or manually via
 ```
 $ gem install jsonapi
 ```
 
 ## Usage
 
-First, `require` the gem.
+First, require the gem:
 ```ruby
 require 'jsonapi'
 ```
 
-Then, parse a JSON API document:
-```ruby
-document = JSONAPI.parse(hash_or_json_string)
-```
-
-or an [include directive](http://jsonapi.org/format/#fetching-includes):
-```ruby
-include_directive = JSONAPI::IncludeDirective.new(include_args)
-```
-
-## Examples
-
-```ruby
-  document = JSONAPI.parse(json_document)
-  # Should the document be invalid, the parse method would fail with an
-  #   InvalidDocument error.
-
-  document.data.links.defined?(:self)
-  # => true
-  document.data.links.self.value
-  # => 'http://example.com/articles/1'
-  document.data.attributes.keys
-  # => ['title']
-  document.data.attributes.defined?(:title)
-  # => true
-  document.data.attributes.title
-  # => 'JSON API paints my bikeshed!'
-  document.data.relationships.keys
-  # => ['author', 'comments']
-  document.data.relationships.defined?(:author)
-  # => true
-  document.data.relationships.author.collection?
-  # => false
-  document.data.relationships.author.data.id
-  # => 9
-  document.data.relationships.author.data.type
-  # => 'people'
-  document.data.relationships.author.links.defined?(:self)
-  # => true
-  document.data.relationships.author.links.self.value
-  # => 'http://example.com/articles/1/relationships/author'
-  document.data.relationships.defined?(:comments)
-  # => true
-  document.data.relationships.comments.collection?
-  # => true
-  document.data.relationships.comments.data.size
-  # => 2
-  document.data.relationships.comments.data[0].id
-  # => 5
-  document.data.relationships.comments.data[0].type
-  # => 'comments'
-  document.data.relationships.comments.links.defined?(:self)
-  # => true
-  document.data.relationships.comments.links.self.value
-  # => 'http://example.com/articles/1/relationships/comments'
-
-  # for the following document_hash
-  document_hash = {
-    'data' =>
-      {
-        'type' => 'articles',
-        'id' => '1',
-        'attributes' => {
-          'title' => 'JSON API paints my bikeshed!'
-        },
-        'links' => {
-          'self' => 'http://example.com/articles/1'
-        },
-        'relationships' => {
-          'author' => {
-            'links' => {
-              'self' => 'http://example.com/articles/1/relationships/author',
-              'related' => 'http://example.com/articles/1/author'
-            },
-            'data' => { 'type' => 'people', 'id' => '9' }
-          },
-          'comments' => {
-            'links' => {
-              'self' => 'http://example.com/articles/1/relationships/comments',
-              'related' => 'http://example.com/articles/1/comments'
-            },
-            'data' => [
-              { 'type' => 'comments', 'id' => '5' },
-              { 'type' => 'comments', 'id' => '12' }
-            ]
-          }
-        }
-      }
-    }
-```
-
-## Contributing
-
-1. Fork the [official repository](https://github.com/beauby/jsonapi_parser/tree/master).
-2. Make your changes in a topic branch.
-3. Send a pull request.
-
-Notes:
-
-* Contributions without tests won't be accepted.
-* Please don't update the Gem version.
+Then, see docs for the part you are interested in:
+* [parsing](parser/README.md)
+* [rendering](renderer/README.md)
 
 ## License
 
-jsonapi is Copyright © 2016 Lucas Hosseini.
-
-It is free software, and may be redistributed under the terms specified in the
-[LICENSE](LICENSE) file.
+jsonapi is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/jsonapi.rb

@@ -1,18 +1,2 @@
-require 'jsonapi/exceptions'
-require 'jsonapi/version'
-
-require 'jsonapi/attributes'
-require 'jsonapi/document'
-require 'jsonapi/error'
-require 'jsonapi/jsonapi'
-require 'jsonapi/link'
-require 'jsonapi/links'
-require 'jsonapi/relationship'
-require 'jsonapi/relationships'
-require 'jsonapi/resource'
-require 'jsonapi/resource_identifier'
-
-require 'jsonapi/parse'
-
-module JSONAPI
-end
+require 'jsonapi/parser'
+require 'jsonapi/renderer'

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1.beta2
+  version: 0.1.1.beta6
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  name: jsonapi-parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 0.1.1.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta3
+- !ruby/object:Gem::Dependency
+  name: jsonapi-renderer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.1.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 0.1.1.beta1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,42 +66,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: Tools for handling JSON API documents
-email:
-- lucas.hosseini@gmail.com
+description: Efficiently parse and render JSONAPI 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_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
 homepage: https://github.com/beauby/jsonapi
 licenses:
 - MIT
@@ -108,13 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 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
+summary: Parse and render JSONAPI documents.
+test_files: []

data/.gitignore

@@ -1,36 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3.0

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Gemfile.lock

@@ -1,36 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jsonapi (0.1.1.beta2)
-      json (~> 1.8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    json (1.8.3)
-    rake (11.1.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  jsonapi!
-  rake (>= 0.9)
-  rspec (~> 3.4)
-
-BUNDLED WITH
-   1.11.2

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Lucas Hosseini
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/Rakefile

@@ -1,7 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new
-
-task default: :spec
-task test: :spec

data/jsonapi_parser.gemspec

@@ -1,24 +0,0 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jsonapi/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'jsonapi'
-  spec.version       = JSONAPI::VERSION
-  spec.authors       = ['Lucas Hosseini']
-  spec.email         = ['lucas.hosseini@gmail.com']
-  spec.summary       = 'Parse and validate JSON API documents'
-  spec.description   = 'Tools for handling JSON API documents'
-  spec.homepage      = 'https://github.com/beauby/jsonapi'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(spec)/})
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'json', '~>1.8'
-
-  spec.add_development_dependency 'rake', '>=0.9'
-  spec.add_development_dependency 'rspec', '~>3.4'
-end

data/lib/jsonapi/attributes.rb

@@ -1,41 +0,0 @@
-module JSONAPI
-  # c.f. http://jsonapi.org/format/#document-resource-object-attributes
-  class Attributes
-    include Enumerable
-
-    def initialize(attributes_hash, options = {})
-      fail InvalidDocument,
-           "the value of 'attributes' MUST be an object" unless
-        attributes_hash.is_a?(Hash)
-
-      @hash = attributes_hash
-      @attributes = {}
-      attributes_hash.each do |attr_name, attr_val|
-        @attributes[attr_name.to_s] = attr_val
-        define_singleton_method(attr_name) do
-          @attributes[attr_name.to_s]
-        end
-      end
-    end
-
-    def to_hash
-      @hash
-    end
-
-    def each(&block)
-      @attributes.each(&block)
-    end
-
-    def [](attr_name)
-      @attributes[attr_name.to_s]
-    end
-
-    def defined?(attr_name)
-      @attributes.key?(attr_name.to_s)
-    end
-
-    def keys
-      @attributes.keys
-    end
-  end
-end