json-api 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 174874158c21768263db5ba08be05a222b6205ce
4
+ data.tar.gz: 8f3f7988fc68a106009353734a2ba1960e119862
5
+ SHA512:
6
+ metadata.gz: 8388f07f2573ff2ee3760ab272e66b2412eec71c0e809118c29104b814302ba303cfdeb0fdb4cf1b2de4ff1ad91a34829ab3e3d628c2120a8cd64ed405f4aa47
7
+ data.tar.gz: b743f7c2ac9267a407751114ca56e6e53d056fe1882ae450127bf9937fb59cb8cc9e5fe2d9b3381ed1a3218e608c9dd7e4c66e00ba766eaca258c83a5f3fa7ba
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in json-api.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Steve Klabnik
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,48 @@
1
+ # JSON::Api
2
+
3
+ [![Build Status](https://travis-ci.org/json-api/parser-ruby.png)](https://travis-ci.org/json-api/parser-ruby) [![Code Climate](https://codeclimate.com/github/json-api/parser-ruby.png)](https://codeclimate.com/github/json-api/parser-ruby)
4
+
5
+ A parser and validator for [JSON API](http://jsonapi.org) documents.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ gem 'json-api'
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install json-api
20
+
21
+ ## Usage
22
+
23
+ ```ruby
24
+ require 'json/api'
25
+
26
+ json = <<-JSON
27
+ {
28
+ "posts": [{
29
+ "id": "1",
30
+ "title": "Rails is Omakase",
31
+ "links": {
32
+ "author": "9",
33
+ "comments": [ "5", "12", "17", "20" ]
34
+ }
35
+ }]
36
+ }
37
+ JSON
38
+
39
+ puts JSON::Api.parse(json).class # => Hash
40
+ ```
41
+
42
+ ## Contributing
43
+
44
+ 1. Fork it
45
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
46
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
47
+ 4. Push to the branch (`git push origin my-new-feature`)
48
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1,14 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ require "bundler/gem_tasks"
4
+
5
+ require 'rake/testtask'
6
+
7
+ Rake::TestTask.new do |t|
8
+ t.libs << "lib"
9
+ t.test_files = FileList['test/*_test.rb']
10
+ t.ruby_opts = ['-r./test/test_helper.rb']
11
+ t.verbose = true
12
+ end
13
+
14
+ task :default => :test
data/json-api.gemspec ADDED
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'json/api/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "json-api"
8
+ spec.version = JSON::Api::VERSION
9
+ spec.authors = ["Steve Klabnik"]
10
+ spec.email = ["steve@steveklabnik.com"]
11
+ spec.description = %q{A JSON API parser.}
12
+ spec.summary = %q{A JSON API parser.}
13
+ spec.homepage = "http://jsonapi.org"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "json-schema"
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.3"
24
+ spec.add_development_dependency "rake"
25
+ end
@@ -0,0 +1,3 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-04/schema#"
3
+ }
@@ -0,0 +1,5 @@
1
+ module JSON
2
+ module Api
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
data/lib/json/api.rb ADDED
@@ -0,0 +1,23 @@
1
+ require "json/api/version"
2
+ require 'json'
3
+ require 'json-schema'
4
+
5
+ module JSON
6
+ module Api
7
+ def self.parse(source, opts={})
8
+ json = JSON.parse(source, opts)
9
+
10
+ validate(json, opts)
11
+
12
+ json
13
+ # rescue
14
+ # nil
15
+ end
16
+
17
+ def self.validate(source, opts={})
18
+ json = JSON.parse(source) if source.kind_of?(String)
19
+
20
+ JSON::Validator.validate!('lib/json/api/schema.json', json)
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,37 @@
1
+ require 'json/api'
2
+
3
+ class AcceptanceTest < MiniTest::Unit::TestCase
4
+ def test_homepage_id_style
5
+ json = <<-JSON
6
+ {
7
+ "posts": [{
8
+ "id": "1",
9
+ "title": "Rails is Omakase",
10
+ "links": {
11
+ "author": "9",
12
+ "comments": [ "5", "12", "17", "20" ]
13
+ }
14
+ }]
15
+ }
16
+ JSON
17
+
18
+ assert JSON::Api.parse(json), "failed to parse"
19
+ end
20
+
21
+ def test_homepage_url_style
22
+ json = <<-JSON
23
+ {
24
+ "posts": [{
25
+ "id": "1",
26
+ "title": "Rails is Omakase",
27
+ "links": {
28
+ "author": "http://example.com/people/1",
29
+ "comments": "http://example.com/comments/5,12,17,20"
30
+ }
31
+ }]
32
+ }
33
+ JSON
34
+
35
+ assert JSON::Api.parse(json), "failed to parse"
36
+ end
37
+ end
@@ -0,0 +1 @@
1
+ require 'minitest/autorun'
metadata ADDED
@@ -0,0 +1,99 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: json-api
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Steve Klabnik
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-12-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: json-schema
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '>='
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '>='
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: '1.3'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ~>
39
+ - !ruby/object:Gem::Version
40
+ version: '1.3'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: A JSON API parser.
56
+ email:
57
+ - steve@steveklabnik.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - .gitignore
63
+ - Gemfile
64
+ - LICENSE.txt
65
+ - README.md
66
+ - Rakefile
67
+ - json-api.gemspec
68
+ - lib/json/api.rb
69
+ - lib/json/api/schema.json
70
+ - lib/json/api/version.rb
71
+ - test/acceptance_test.rb
72
+ - test/test_helper.rb
73
+ homepage: http://jsonapi.org
74
+ licenses:
75
+ - MIT
76
+ metadata: {}
77
+ post_install_message:
78
+ rdoc_options: []
79
+ require_paths:
80
+ - lib
81
+ required_ruby_version: !ruby/object:Gem::Requirement
82
+ requirements:
83
+ - - '>='
84
+ - !ruby/object:Gem::Version
85
+ version: '0'
86
+ required_rubygems_version: !ruby/object:Gem::Requirement
87
+ requirements:
88
+ - - '>='
89
+ - !ruby/object:Gem::Version
90
+ version: '0'
91
+ requirements: []
92
+ rubyforge_project:
93
+ rubygems_version: 2.0.3
94
+ signing_key:
95
+ specification_version: 4
96
+ summary: A JSON API parser.
97
+ test_files:
98
+ - test/acceptance_test.rb
99
+ - test/test_helper.rb