jsonapi_spec_helpers 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87e14751c4b6dcc5f51ea355dff331af2808a441
+  data.tar.gz: bd553e0fbdb64709c17912793c5c6d79d06ae871
+SHA512:
+  metadata.gz: 346d1d9f491b556fb25014d907e58431092758abc348d13cd134265abbc6962a039ed4ef14fce37f65c097733dfa641bc78c6453095daf6c02e87be027618908
+  data.tar.gz: 3f69503875a7f47dd496c6f3f4e53a463760752b24b669244d378e44245f483a77a6fb94cc8a81140f1e64baf08f0a55641f75539f6a2927693c3ce2a8295364

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,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lee Richmond
+
+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,5 @@
+# JsonapiSpecHelpers
+
+A collection of spec helpers for asserting on jsonapi.org responses.
+
+[View official documentation](https://bbgithub.dev.bloomberg.com/pages/InfrastructureExperience/jsonapi_spec_helpers)

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_helpers"
+
+# 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/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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_helpers.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi_spec_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi_spec_helpers"
+  spec.version       = JsonapiSpecHelpers::VERSION
+  spec.authors       = ["Lee Richmond"]
+  spec.email         = ["lrichmond1@bloomberg.net"]
+
+  spec.summary       = %q{Spec helpers for jsonapi}
+  spec.description   = %q{Includes factory-style payload assertions}
+  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_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "actionpack", "~> 5.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/jsonapi_spec_helpers.rb

@@ -0,0 +1,133 @@
+require 'pry'
+require 'pry-byebug'
+
+require 'json'
+require 'jsonapi_spec_helpers/version'
+require 'jsonapi_spec_helpers/payload'
+
+RSpec::Matchers.define :match_payload do |attribute, expected|
+  match do |actual|
+    # cast to_json for things like Time
+    actual.to_json == expected.to_json
+  end
+
+  failure_message do |actual|
+    "Expected JSON payload to have key '#{attribute}' == #{expected.inspect} but was #{actual.inspect}"
+  end
+end
+
+RSpec::Matchers.define :have_payload_key do |expected|
+  match do |json|
+    json.has_key?(expected.to_s)
+  end
+
+  failure_message do |actual|
+    "Expected JSON payload to have key '#{expected}' but was not present"
+  end
+
+  failure_message_when_negated do |actual|
+    "Expected JSON payload to NOT have key '#{expected}' but was present"
+  end
+end
+
+RSpec::Matchers.define :be_not_in_payload do |expected|
+  match do |json|
+    false
+  end
+
+  failure_message do |actual|
+    "JSON payload contained unexpected key '#{actual}'"
+  end
+end
+
+module JsonapiSpecHelpers
+  def self.included(klass)
+    if defined?(Rails)
+      Dir[Rails.root.join('spec/payloads/**/*.rb')].each { |f| require f }
+    end
+  end
+
+  def json
+    JSON.parse(response.body)
+  end
+
+  def json_item(from: nil)
+    from = json if from.nil?
+    data = from.has_key?('data') ? from['data'] : from
+
+    {}.tap do |item|
+      item['id'] = data['id']
+      item['jsonapi_type'] = data['type']
+      item.merge!(data['attributes'])
+    end
+  end
+
+  def json_items(*indices)
+    items   = []
+    json['data'].each_with_index do |datum, index|
+      included = indices.empty? || indices.include?(index)
+      items << json_item(from: datum) if included
+    end
+    indices.length == 1 ? items[0] : items
+  end
+
+  def json_related_link(payload, assn_name)
+    link = payload['relationships'][assn_name]['links']['related']['href']
+    fail "link for #{assn_name} not found" unless link
+    URI.decode(link)
+  end
+
+  def json_included_types
+    (json['included'] || []).map { |i| i['type'] }.uniq
+  end
+
+  def json_includes(type, *indices)
+    included = (json['included'] || []).select { |data| data['type'] == type }
+    indices  = (0...included.length).to_a if indices.empty?
+    includes = []
+    indices.each do |index|
+      includes << json_item(from: included.at(index))
+    end
+    includes
+  end
+
+  def json_include(type, index = 0)
+    json_includes(type, index)[0]
+  end
+
+  def json_ids(integers = false)
+    ids = json['data'].map { |d| d['id'] }
+    ids.map!(&:to_i) if integers
+    ids
+  end
+
+  def assert_payload(name, record, json, &blk)
+    unless payload = JsonapiSpecHelpers::Payload.registry[name]
+      raise "No payloads registered for '#{name}'"
+    end
+
+    # todo dup payload
+    if blk
+      payload = payload.fork
+      payload.instance_eval(&blk)
+    end
+
+    aggregate_failures "payload has correct key/values" do
+      payload.keys.each_pair do |attribute, prc|
+        if (expect(json).to have_payload_key(attribute)) == true
+          expect(json[attribute.to_s]).to match_payload(attribute, prc.call(record))
+        end
+      end
+
+      payload.no_keys.each do |no_key|
+        expect(json).to_not have_payload_key(no_key)
+      end
+
+      unexpected_keys = json.keys - payload.keys.keys.map(&:to_s)
+      unexpected_keys.reject! { |k| %w(id jsonapi_type).include?(k) }
+      unexpected_keys.each do |key|
+        expect(key).to be_not_in_payload
+      end
+    end
+  end
+end

data/lib/jsonapi_spec_helpers/payload.rb

@@ -0,0 +1,45 @@
+module JsonapiSpecHelpers
+  class Payload
+    class << self
+      attr_accessor :registry
+    end
+    self.registry = {}
+
+    attr_accessor :keys, :no_keys
+
+    def self.register(name, &blk)
+      instance = new
+      instance.instance_eval(&blk)
+      registry[name] = instance
+    end
+
+    def fork
+      instance = self.class.new
+      instance.keys = keys.dup
+      instance.no_keys = no_keys.dup
+      instance
+    end
+
+    def initialize
+      @keys = {}
+      @no_keys = []
+    end
+
+    def no_key(name)
+      @keys.delete(name)
+      @no_keys << name
+    end
+
+    def key(name, &blk)
+      @no_keys.reject! { |k| k == name }
+      prc = blk
+      prc = ->(record) { record.send(name) } if prc.nil?
+      @keys[name] = prc
+    end
+
+    def timestamps!
+      @keys[:created_at] = ->(record) { record.created_at }
+      @keys[:updated_at] = ->(record) { record.updated_at }
+    end
+  end
+end

data/lib/jsonapi_spec_helpers/version.rb

@@ -0,0 +1,3 @@
+module JsonapiSpecHelpers
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_spec_helpers
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Lee Richmond
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: Includes factory-style payload assertions
+email:
+- lrichmond1@bloomberg.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- jsonapi_spec_helpers.gemspec
+- lib/jsonapi_spec_helpers.rb
+- lib/jsonapi_spec_helpers/payload.rb
+- lib/jsonapi_spec_helpers/version.rb
+homepage: 
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Spec helpers for jsonapi
+test_files: []
+has_rdoc: