graphiti_spec_helpers 1.0.alpha.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2dd06fa716ef3c85458ecec2eabc4e3a9414f13
+  data.tar.gz: 98850e048dcacf2492dee1977f5492c98be78f35
+SHA512:
+  metadata.gz: 38f19368c9473f355d43f119f7912231401b3d0e038d7b5f1a675998f7eec4648d6e3159ae95025eb975c58e8b94be3cc07fbb5762bc22fde76d1dce0dd6f5c9
+  data.tar.gz: f05c237713ea1dfd8981f893195514e23a4f30fb677889e23e6d977602684c1077629860a12baee694181b7e74bc94c6664f70d5e19345c6ede48d3b353a340f

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 graphiti_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,7 @@
+# JsonapiSpecHelpers
+
+[![Build Status](https://travis-ci.org/jsonapi-suite/jsonapi_spec_helpers.svg?branch=master)](https://travis-ci.org/jsonapi-suite/jsonapi_spec_helpers)
+
+A collection of spec helpers for asserting on jsonapi.org responses.
+
+[View official documentation](http://jsonapi-suite.github.io/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 "grpahiti_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/graphiti_spec_helpers.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'graphiti_spec_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "graphiti_spec_helpers"
+  spec.version       = GraphitiSpecHelpers::VERSION
+  spec.authors       = ["Lee Richmond"]
+  spec.email         = ["lrichmond1@bloomberg.net"]
+
+  spec.summary       = %q{Spec helpers for Graphiti and JSONAPI}
+  spec.description   = %q{Easily test JSONAPIs and Graphiti Resources}
+  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 "graphiti", '>= 1.0.alpha.1'
+  spec.add_dependency "rspec", "~> 3.0"
+end

data/lib/graphiti_spec_helpers.rb

@@ -0,0 +1,37 @@
+require 'json'
+require 'pp'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+require 'graphiti'
+
+require 'graphiti_spec_helpers/version'
+require 'graphiti_spec_helpers/helpers'
+require 'graphiti_spec_helpers/node'
+require 'graphiti_spec_helpers/errors_proxy'
+require 'graphiti_spec_helpers/errors'
+
+module GraphitiSpecHelpers
+  def self.included(klass)
+    klass.send(:include, Helpers)
+  end
+
+  class TestRunner < ::Graphiti::Runner
+    def current_user
+      nil
+    end
+  end
+
+  module Sugar
+    def d
+      jsonapi_data
+    end
+
+    def included(type = nil)
+      jsonapi_included(type)
+    end
+
+    def errors
+      jsonapi_errors
+    end
+  end
+end

data/lib/graphiti_spec_helpers/errors.rb

@@ -0,0 +1,51 @@
+module GraphitiSpecHelpers
+  module Errors
+    class Base < StandardError; end
+
+    class LinksNotFound < Base
+      def initialize(name)
+        @name = name
+      end
+
+      def message
+        "Relationship with name '#{@name}' has no links!"
+      end
+    end
+
+    class SideloadNotFound < Base
+      def initialize(name)
+        @name = name
+      end
+
+      def message
+        "Relationship with name '#{@name}' not found!"
+      end
+    end
+
+    class NoResponse < Base
+      def message
+        "Cannot parse response - missing #response.body!"
+      end
+    end
+
+    class NoData < Base
+      def initialize(payload)
+        @payload = payload
+      end
+
+      def message
+        "Payload did not contain 'data'! Payload was:\n\n#{JSON.pretty_generate(@payload)}"
+      end
+    end
+
+    class NoSideloads < Base
+      def initialize(payload)
+        @payload = payload
+      end
+
+      def message
+        "Tried to find sideload, but the payload did not contain 'included'! Payload was:\n\n#{JSON.pretty_generate(@payload)}"
+      end
+    end
+  end
+end

data/lib/graphiti_spec_helpers/errors_proxy.rb

@@ -0,0 +1,70 @@
+module GraphitiSpecHelpers
+  class ErrorsProxy
+    class Error
+      attr_reader :json
+
+      def initialize(json)
+        @json = json
+      end
+
+      def attribute
+        @json[:meta][:attribute]
+      end
+
+      # TODO: move to top-level code in errorable
+      def code
+        @json[:meta][:code]
+      end
+
+      def message
+        @json[:meta][:message]
+      end
+
+      def title
+        @json[:title]
+      end
+
+      def detail
+        @json[:detail]
+      end
+
+      def status
+        @json[:status]
+      end
+    end
+
+    include Enumerable
+
+    def initialize(array)
+      @errors = array.map { |e| Error.new(e) }
+    end
+
+    def [](key)
+      @errors[key]
+    end
+
+    def each(&blk)
+      @errors.each(&blk)
+    end
+
+    def length
+      count
+    end
+
+    def to_h
+      {}.tap do |hash|
+        @errors.each do |e|
+          hash[e.attribute] = e.message
+        end
+      end
+    end
+
+    def method_missing(id, *args, &blk)
+      if error = @errors.find { |e| e.attribute == id }
+        return error
+      else
+        super
+      end
+    end
+  end
+end

data/lib/graphiti_spec_helpers/helpers.rb

@@ -0,0 +1,97 @@
+module GraphitiSpecHelpers
+  module Helpers
+    extend ActiveSupport::Concern
+
+    def json
+      if response && response.body
+        JSON.parse(response.body).with_indifferent_access
+      else
+        raise Errors::NoResponse.new
+      end
+    end
+
+    def jsonapi_data
+      @jsonapi_data ||= begin
+        if _jsonapi_data.is_a?(Hash)
+          node(from: _jsonapi_data)
+        else
+          _jsonapi_data.map { |datum| node(from: datum) }
+        end
+      end
+    end
+
+    def jsonapi_included(type = nil)
+      variable = :"@jsonapi_included#{type}"
+      memo = instance_variable_get(variable)
+      return memo if memo
+
+      nodes =  _jsonapi_included.map { |i| node(from: i) }
+      if type
+        nodes.select! { |n| n.jsonapi_type == type }
+      end
+      instance_variable_set(variable, nodes)
+      nodes
+    end
+
+    def jsonapi_errors
+      @jsonapi_errors ||= ErrorsProxy.new(json['errors'] || [])
+    end
+
+    def jsonapi_headers
+      {
+        'CONTENT_TYPE' => 'application/vnd.api+json'
+      }
+    end
+
+    def jsonapi_get(url, params: {})
+      get url, params: params, headers: jsonapi_headers
+    end
+
+    def jsonapi_post(url, payload)
+      post url, params: payload.to_json, headers: jsonapi_headers
+    end
+
+    def jsonapi_put(url, payload)
+      put url, params: payload.to_json, headers: jsonapi_headers
+    end
+
+    def jsonapi_patch(url, payload)
+      patch url, params: payload.to_json, headers: jsonapi_headers
+    end
+
+    def jsonapi_delete(url)
+      delete url, headers: jsonapi_headers
+    end
+
+    def datetime(value)
+      Graphiti::Types[:datetime][:read][value]
+    end
+
+    # @api private
+    def node(from: nil)
+      from = json if from.nil?
+      data = from.has_key?('data') ? from['data'] : from
+      hash = {}
+      hash['id'] = data['id']
+      hash['jsonapi_type'] = data['type']
+      hash.merge!(data['attributes']) if data.has_key?('attributes')
+      Node.new(hash, data['relationships'], self)
+    end
+
+    private
+
+    # @api private
+    def _jsonapi_data
+      json['data'] || raise(Errors::NoData.new(json))
+    end
+
+    # @api private
+    def _jsonapi_included
+      if json.has_key?('included')
+        json['included']
+      else
+        raise Errors::NoSideloads.new(json)
+      end
+    end
+  end
+end

data/lib/graphiti_spec_helpers/node.rb

@@ -0,0 +1,81 @@
+module GraphitiSpecHelpers
+  class Node
+    attr_reader :attributes, :relationships
+
+    def initialize(attributes, relationships, context)
+      @attributes = attributes.with_indifferent_access
+      @relationships = relationships
+      @context = context
+    end
+
+    def id
+      rawid.to_i
+    end
+
+    def rawid
+      @attributes['id']
+    end
+
+    def jsonapi_type
+      @attributes['jsonapi_type']
+    end
+
+    def has_key?(key)
+      @attributes.has_key?(key)
+    end
+
+    def [](key)
+      @attributes[key] || @attributes[key.to_s]
+    end
+
+    def []=(key, val)
+      @attributes[key] = val
+    end
+
+    def attributes
+      @attributes
+    end
+
+    def method_missing(id, *args, &blk)
+      if @attributes.has_key?(id)
+        @attributes[id]
+      else
+        super
+      end
+    end
+
+    def link(relationship_name, name)
+      if @relationships.has_key?(relationship_name)
+        links = @relationships[relationship_name][:links]
+        raise Errors::LinksNotFound.new(relationship_name) unless links
+        links[name]
+      else
+        raise Errors::SideloadNotFound.new(relationship_name)
+      end
+    end
+
+    def sideload(relationship_name)
+      unless @relationships.has_key?(relationship_name)
+        raise Errors::SideloadNotFound.new(relationship_name)
+      end
+      rel = @relationships[relationship_name]
+      rel = rel[:data]
+      return if rel.nil?
+      if rel.is_a?(Hash)
+        include_for(rel[:type], rel[:id])
+      else
+        rel.map { |r| include_for(r[:type], r[:id]) }
+      end
+    end
+    alias :sideloads :sideload
+
+    private
+
+    def include_for(type, id)
+      data = @context.json[:included].find do |i|
+        i[:type] == type && i[:id] == id
+      end
+      @context.node(from: data)
+    end
+  end
+end

data/lib/graphiti_spec_helpers/rspec.rb

@@ -0,0 +1,64 @@
+require 'graphiti_spec_helpers'
+
+::RSpec.shared_context 'resource testing', type: :resource do |parameter|
+  let(:resource)     { described_class }
+  let(:params)       { {} }
+
+  # If you need to set context:
+  #
+  # Graphiti.with_context my_context, {} do
+  #   render
+  # end
+  def render(runtime_options = {})
+    json = proxy.to_jsonapi(runtime_options)
+    response.body = json
+    json
+  end
+
+  def proxy
+    @proxy ||= begin
+      ctx = ::GraphitiSpecHelpers::TestRunner.new(resource, params)
+      defined?(base_scope) ? ctx.proxy(base_scope) : ctx.proxy
+    end
+  end
+
+  def records
+    proxy.data
+  end
+
+  def response
+    @response ||= OpenStruct.new
+  end
+end
+
+module GraphitiSpecHelpers
+  module RSpec
+    def self.included(klass)
+      klass.send(:include, GraphitiSpecHelpers)
+
+      ::RSpec.configure do |rspec|
+        rspec.include_context "resource testing", type: :resource
+      end
+    end
+
+    def self.schema!(resources = nil)
+      ::RSpec.describe 'Graphiti Schema' do
+        it 'generates a backwards-compatible schema' do
+          message = <<-MSG
+Found backwards-incompatibilities in schema! Run with FORCE_SCHEMA=true to ignore.
+
+Incompatibilities:
+
+          MSG
+
+          errors = Graphiti::Schema.generate!(resources)
+          errors.each do |e|
+            message << "#{e}\n"
+          end
+
+          expect(errors.empty?).to eq(true), message
+        end
+      end
+    end
+  end
+end

data/lib/graphiti_spec_helpers/version.rb

@@ -0,0 +1,3 @@
+module GraphitiSpecHelpers
+  VERSION = "1.0.alpha.2"
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: graphiti_spec_helpers
+version: !ruby/object:Gem::Version
+  version: 1.0.alpha.2
+platform: ruby
+authors:
+- Lee Richmond
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-03 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: graphiti
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.alpha.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.alpha.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Easily test JSONAPIs and Graphiti Resources
+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
+- graphiti_spec_helpers.gemspec
+- lib/graphiti_spec_helpers.rb
+- lib/graphiti_spec_helpers/errors.rb
+- lib/graphiti_spec_helpers/errors_proxy.rb
+- lib/graphiti_spec_helpers/helpers.rb
+- lib/graphiti_spec_helpers/node.rb
+- lib/graphiti_spec_helpers/rspec.rb
+- lib/graphiti_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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Spec helpers for Graphiti and JSONAPI
+test_files: []