jsonapi_spec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4767c13831a0abcbed0a27c692268e55971e32ef
+  data.tar.gz: 94849dbb71963911cda3bac371eb5c0603c311e2
+SHA512:
+  metadata.gz: 8e89bd9950ce409316eac173146ffa7b99c298901fde426db1d99a70a42eb47eacd11a3e57d4b19b1eb7f7685cf479ca79c75807da668bd9d52c18eaae884817
+  data.tar.gz: 46f0885fb38b6bf91527ec1b4a89184cb076b0801b543cf17ad859cbe1ed469d1354455e2496d0d081cc1a326a0ca92e8368dc84040d651891a578dc6285f880

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.0.pre.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi_spec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ahmad Suhendri
+
+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/README.md

@@ -0,0 +1,41 @@
+# JsonapiSpec
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jsonapi_spec`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi_spec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi_spec
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jsonapi_spec.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsonapi_spec"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jsonapi_spec.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi_spec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi_spec"
+  spec.version       = JsonapiSpec::VERSION
+  spec.authors       = ["Ahmad Suhendri"]
+  spec.email         = ["ahmadsoe@gmail.com"]
+
+  spec.summary       = %q{RSpec matchers for testing JSON API content}
+  spec.description   = %q{RSpec matchers for testing JSON API content}
+  spec.homepage      = "https://github.com/ahmadsoe/jsonapi_spec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jsonapi_parser", "~> 0.4"
+  spec.add_dependency "rspec", "~> 3.0", ">= 3.0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jsonapi_spec/helpers.rb

@@ -0,0 +1,11 @@
+require 'json/api'
+
+module JsonapiSpec
+  module Helpers
+    extend self
+
+    def parse_jsonapi(json)
+      JSON::API.parse(json)
+    end
+  end
+end

data/lib/jsonapi_spec/matchers/be_valid_jsonapi.rb

@@ -0,0 +1,23 @@
+module JsonapiSpec
+  module Matchers
+    class BeValidJsonapi
+      include JsonapiSpec::Helpers
+
+      def matches?(json)
+        parse_jsonapi(json)
+        true
+      rescue JSON::API::InvalidDocument => ex
+        @validate_error_message = ex.message
+        false
+      end
+
+      def failure_message
+        "Not a valid jsonapi #{@validate_error_message}"
+      end
+
+      def failure_message_when_negated
+        "Valid jsonapi"
+      end
+    end
+  end
+end

data/lib/jsonapi_spec/matchers/have_jsonapi_attribute.rb

@@ -0,0 +1,26 @@
+module JsonapiSpec
+  module Matchers
+    class HaveJsonapiAttribute
+      include JsonapiSpec::Helpers
+
+      def initialize(attribute)
+        @attribute = attribute
+      end
+
+      def matches?(json)
+        document = parse_jsonapi(json)
+        document.data.attributes.defined?(@attribute)
+      rescue JSON::API::InvalidDocument
+        false
+      end
+
+      def failure_message
+        "Not have a attribute #{@attribute}"
+      end
+
+      def failure_message_when_negated
+        "have jsonapi attribute #{@attribute}"
+      end
+    end
+  end
+end

data/lib/jsonapi_spec/matchers/have_jsonapi_error.rb

@@ -0,0 +1,24 @@
+module JsonapiSpec
+  module Matchers
+    class HaveJsonapiError
+      include JsonapiSpec::Helpers
+
+      def matches?(json)
+        document = parse_jsonapi(json)
+        return false if document.errors.nil?
+        true
+      rescue JSON::API::InvalidDocument => ex
+        @validate_error_message = ex.message
+        false
+      end
+
+      def failure_message
+        "Not a valid jsonapi error #{@validate_error_message}"
+      end
+
+      def failure_message_when_negated
+        "Valid jsonapi error"
+      end
+    end
+  end
+end

data/lib/jsonapi_spec/matchers/have_jsonapi_link.rb

@@ -0,0 +1,26 @@
+module JsonapiSpec
+  module Matchers
+    class HaveJsonapiLink
+      include JsonapiSpec::Helpers
+
+      def initialize(link)
+        @link = link
+      end
+
+      def matches?(json)
+        document = parse_jsonapi(json)
+        document.links.defined?(@link)
+      rescue JSON::API::InvalidDocument
+        false
+      end
+
+      def failure_message
+        "Not have a links #{@link}"
+      end
+
+      def failure_message_when_negated
+        "have jsonapi link #{@link}"
+      end
+    end
+  end
+end

data/lib/jsonapi_spec/matchers/have_jsonapi_relationship.rb

@@ -0,0 +1,26 @@
+module JsonapiSpec
+  module Matchers
+    class HaveJsonapiRelationship
+      include JsonapiSpec::Helpers
+
+      def initialize(relationship)
+        @relationship = relationship
+      end
+
+      def matches?(json)
+        document = parse_jsonapi(json)
+        document.data.relationships.defined?(@relationship)
+      rescue JSON::API::InvalidDocument
+        false
+      end
+
+      def failure_message
+        "Not have a relationship #{@relationship}"
+      end
+
+      def failure_message_when_negated
+        "have jsonapi relationship #{@relationship}"
+      end
+    end
+  end
+end

data/lib/jsonapi_spec/matchers.rb

@@ -0,0 +1,33 @@
+require 'jsonapi_spec/matchers/be_valid_jsonapi'
+require 'jsonapi_spec/matchers/have_jsonapi_link'
+require 'jsonapi_spec/matchers/have_jsonapi_relationship'
+require 'jsonapi_spec/matchers/have_jsonapi_attribute'
+require 'jsonapi_spec/matchers/have_jsonapi_error'
+
+module JsonapiSpec
+  module Matchers
+    def be_valid_jsonapi
+      JsonapiSpec::Matchers::BeValidJsonapi.new
+    end
+
+    def have_jsonapi_link(link)
+      JsonapiSpec::Matchers::HaveJsonapiLink.new(link)
+    end
+
+    def have_jsonapi_relationship(relationship)
+      JsonapiSpec::Matchers::HaveJsonapiRelationship.new(relationship)
+    end
+
+    def have_jsonapi_attribute(attribute)
+      JsonapiSpec::Matchers::HaveJsonapiAttribute.new(attribute)
+    end
+
+    def have_jsonapi_error
+      JsonapiSpec::Matchers::HaveJsonapiError.new
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include JsonapiSpec::Matchers
+end

data/lib/jsonapi_spec/version.rb

@@ -0,0 +1,3 @@
+module JsonapiSpec
+  VERSION = "0.1.0"
+end

data/lib/jsonapi_spec.rb

@@ -0,0 +1,8 @@
+require "rspec"
+require "jsonapi_spec/version"
+require "jsonapi_spec/helpers"
+require "jsonapi_spec/matchers"
+
+module JsonapiSpec
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_spec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmad Suhendri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: RSpec matchers for testing JSON API content
+email:
+- ahmadsoe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi_spec.gemspec
+- lib/jsonapi_spec.rb
+- lib/jsonapi_spec/helpers.rb
+- lib/jsonapi_spec/matchers.rb
+- lib/jsonapi_spec/matchers/be_valid_jsonapi.rb
+- lib/jsonapi_spec/matchers/have_jsonapi_attribute.rb
+- lib/jsonapi_spec/matchers/have_jsonapi_error.rb
+- lib/jsonapi_spec/matchers/have_jsonapi_link.rb
+- lib/jsonapi_spec/matchers/have_jsonapi_relationship.rb
+- lib/jsonapi_spec/version.rb
+homepage: https://github.com/ahmadsoe/jsonapi_spec
+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: RSpec matchers for testing JSON API content
+test_files: []