Initial commit.

Author: beauby

Gemfile

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

README.md

@@ -0,0 +1,65 @@
+# jsonapi-rspec
+
+RSpec matchers for [JSON API](http://jsonapi.org).
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/jsonapi-rspec.svg)](https://badge.fury.io/rb/jsonapi-rspec)
+[![Build Status](https://secure.travis-ci.org/jsonapi-rb/jsonapi-rspec.svg?branch=master)](http://travis-ci.org/jsonapi-rb/jsonapi-rspec?branch=master)
+[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/jsonapi-rb/Lobby)
+
+## Resources
+
+* Chat: [gitter](http://gitter.im/jsonapi-rb)
+* Twitter: [@jsonapirb](http://twitter.com/jsonapirb)
+
+## Installation
+
+Add the following to your application's Gemfile:
+```ruby
+gem 'jsonapi-rspec'
+```
+And then execute:
+```
+$ bundle
+```
+
+Add to your `spec/spec_helpers.rb`:
+
+```ruby
+# spec/spec_helpers.rb
+RSpec.configure do |config|
+  # ...
+  config.include JSONAPI::RSpec
+end
+```
+
+## Usage and documentation
+
+Available matchers:
+
+* `expect(document['data']).to have_id('12')`
+* `expect(document['data']).to have_type('users')`
+* `expect(document['data']).to have_attributes(:name, :email)`
+* `expect(document['data']).to have_attribute(:name).with_value('Lucas')`
+* `expect(document['data']).to have_relationships(:posts, :comments)`
+* `expect(document['data']).to have_relationship(:posts).with_data([{ 'id' => '1', 'type' => 'posts' }])`
+* `expect(document['data']['relationships']['posts']).to have_links(:self, :related)`
+* `expect(document['data']).to have_link(:self).with_value('http://api.example.com/users/12')`
+* `expect(document).to have_meta`
+* `expect(document).to have_meta('foo' => 'bar')`
+* `expect(document).to have_jsonapi_object`
+* `expect(document).to have_jsonapi_object('version' => '1.0')`
+
+## Advanced examples
+
+Checking for an included resource:
+
+```ruby
+expect(response_body['included'])
+  .to include(have_type('posts').and have_id('1'))
+```
+
+## License
+
+jsonapi-rspec is released under the [MIT License](http://www.opensource.org/licenses/MIT).

VERSION

@@ -0,0 +1 @@
+0.0.1

jsonapi-rspec.gemspec

@@ -0,0 +1,18 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jsonapi-rspec'
+  spec.version       = version
+  spec.author        = ['Lucas Hosseini']
+  spec.email         = ['[email protected]']
+  spec.summary       = 'RSpec matchers for JSON API.'
+  spec.description   = 'Helpers for validating JSON API payloads'
+  spec.homepage      = 'https://github.com/jsonapi-rb/jsonapi-rspec'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['README.md', 'lib/**/*']
+  spec.require_path  = 'lib'
+
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+end

lib/jsonapi/rspec.rb

@@ -0,0 +1,19 @@
+require 'jsonapi/rspec/id'
+require 'jsonapi/rspec/type'
+require 'jsonapi/rspec/attributes'
+require 'jsonapi/rspec/relationships'
+require 'jsonapi/rspec/links'
+require 'jsonapi/rspec/meta'
+require 'jsonapi/rspec/jsonapi_object'
+
+module JSONAPI
+  module RSpec
+    include Id
+    include Type
+    include Attributes
+    include Relationships
+    include Links
+    include Meta
+    include JsonapiObject
+  end
+end

lib/jsonapi/rspec/attributes.rb

@@ -0,0 +1,25 @@
+module JSONAPI
+  module RSpec
+    module Attributes
+      ::RSpec::Matchers.define :have_attribute do |attr|
+        match do |actual|
+          (actual['attributes'] || {}).key?(attr.to_s) &&
+            (!@val_set || actual['attributes'][attr.to_s] == @val)
+        end
+
+        chain :with_value do |val|
+          @val_set = true
+          @val = val
+        end
+      end
+
+      ::RSpec::Matchers.define :have_attributes do |*attrs|
+        match do |actual|
+          return false unless actual.key?('attributes')
+
+          attrs.all? { |attr| actual['attributes'].key?(attr.to_s) }
+        end
+      end
+    end
+  end
+end

lib/jsonapi/rspec/id.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module RSpec
+    module Id
+      ::RSpec::Matchers.define :have_id do |expected|
+        match { |actual| actual['id'] == expected }
+      end
+    end
+  end
+end

lib/jsonapi/rspec/jsonapi_object.rb

@@ -0,0 +1,12 @@
+module JSONAPI
+  module RSpec
+    module JsonapiObject
+      ::RSpec::Matchers.define :have_jsonapi_object do |val|
+        match do |actual|
+          actual.key?('jsonapi') &&
+            (!val || actual['jsonapi'] == val)
+        end
+      end
+    end
+  end
+end

lib/jsonapi/rspec/links.rb

@@ -0,0 +1,25 @@
+module JSONAPI
+  module RSpec
+    module Links
+      ::RSpec::Matchers.define :have_link do |link|
+        match do |actual|
+          actual.key?('links') && actual['links'].key?(link.to_s) &&
+            (!@val_set || actual['links'] == @val)
+        end
+
+        chain :with_value do |val|
+          @val_set = true
+          @val = val
+        end
+      end
+
+      ::RSpec::Matchers.define :have_links do |*links|
+        match do |actual|
+          return false unless actual.key?('links')
+
+          links.all? { |link| actual['links'].key?(link.to_s) }
+        end
+      end
+    end
+  end
+end

lib/jsonapi/rspec/meta.rb

@@ -0,0 +1,12 @@
+module JSONAPI
+  module RSpec
+    module Meta
+      ::RSpec::Matchers.define :have_meta do |val|
+        match do |actual|
+          actual.key?('meta') &&
+            (!val || actual['meta'] == val)
+        end
+      end
+    end
+  end
+end

lib/jsonapi/rspec/relationships.rb

@@ -0,0 +1,34 @@
+module JSONAPI
+  module RSpec
+    module Relationships
+      ::RSpec::Matchers.define :have_relationship do |rel|
+        match do |actual|
+          return false unless (actual['relationships'] || {}).key?(rel.to_s)
+
+          !@data_set || actual['relationships'][rel.to_s]['data'] == @data_val
+        end
+
+        chain :with_data do |val|
+          @data_set = true
+          @data_val = val
+        end
+
+        failure_message do |actual|
+          if !(actual['relationships'] || {}).key?(rel.to_s)
+            "expected #{actual} to have relationship #{rel}"
+          else
+            "expected #{actual['relationships'][rel.to_s]} to have data #{@data_val}"
+          end
+        end
+      end
+
+      ::RSpec::Matchers.define :have_relationships do |*rels|
+        match do |actual|
+          return false unless actual.key?('relationships')
+
+          rels.all? { |rel| actual['relationships'].key?(rel) }
+        end
+      end
+    end
+  end
+end

lib/jsonapi/rspec/type.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  module RSpec
+    module Type
+      ::RSpec::Matchers.define :have_type do |expected|
+        match { |actual| actual['type'] == expected }
+      end
+    end
+  end
+end