jsonapi_expectations 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e54a36f06982325f2f32397b6166e6825dc0cd82
+  data.tar.gz: 533ff06dd33dfbb49323405f5ab2a449ab762640
+SHA512:
+  metadata.gz: 56243ec14d0edfe0b80808f8f534cefb1805dd78029de937039deb832c2ad529f9abfd08bd3a53c231ff2c7406b4496a13f78722ffb5e16a656265abdd566e60
+  data.tar.gz: 6f4279038148b436d332c7ae2578881c37a79a0121cdfa52da6bd25bc00b7750e02b833872d7b0160779ab16db2f37f820af7c7ed6c964ebe5ea12a9f619d7a1

data/lib/jsonapi_expectations.rb

@@ -0,0 +1,102 @@
+require 'airborne'
+
+module JsonapiExpectations
+  def expect_attributes attrs
+    expect(json_body[:data]).to_not be_empty
+    expect_json 'data.attributes', dasherize_keys(attrs)
+  end
+
+  def expect_attributes_in_list attrs
+    expect(json_body[:data]).to_not be_empty
+    expect_json 'data.?.attributes', dasherize_keys(attrs)
+  end
+
+  def expect_relationship opts
+    # If looking for item in a list, need to change location string
+    location = if opts[:in_list]
+                 "data.?.relationships.#{opts[:key]}"
+               else
+                 "data.relationships.#{opts[:key]}"
+               end
+
+    if opts[:link]
+      begin
+        expect_json "#{location}.links.related", opts[:link]
+      rescue # check if it's in an array
+        expect_json "#{location}.?.links.related", opts[:link]
+      end
+    end
+
+    if opts[:id]
+      location = "#{location}.data"
+      type = opts[:type] || opts[:key].pluralize
+
+      if opts[:id].respond_to? :each # if an array was passed in, look for each of them
+        opts[:id].each do |id|
+          expect_linkage_data "#{location}.?", { type: type, id: id }, opts[:included]
+        end
+      else # otherwise just look for it
+        expect_linkage_data location, { type: type, id: opts[:id] }, opts[:included]
+      end
+    end
+  end
+
+  def expect_relationship_in_list opts
+    opts[:in_list] = true
+    expect_relationship opts
+  end
+
+  def expect_item_count number
+    expect_json_sizes data: number
+  end
+
+  def expect_item_in_list find_me, opts = {}
+    opts[:type] ||= jsonapi_type find_me
+    expect(json_body[:data]).to_not be_empty
+    found = json_body[:data].detect do |item|
+      jsonapi_match? find_me, item, opts[:type]
+    end
+    expect(found).to be_truthy
+  end
+
+  def expect_item_to_not_be_in_list dont_find_me, opts = {}
+    opts[:type] ||= jsonapi_type dont_find_me
+    expect(json_body[:data]).to_not be_empty
+    json_body[:data].each do |item|
+      expect(jsonapi_match?(dont_find_me, item, opts[:type])).to be_falsey
+    end
+  end
+
+  ## Finder helpers
+
+  def find_record_in_response record, opts = {}
+    opts[:type] ||= jsonapi_type(record)
+    json_body[:data].select do |item|
+      item[:id]&.to_s == record.id&.to_s && item[:type] == opts[:type]
+    end.first
+  end
+
+  private
+
+  def expect_linkage_data location, relationship_data, included
+    begin
+      expect_json location, relationship_data
+    rescue # check if it's in an array
+      expect_json "#{location}.?", relationship_data
+    end
+
+    expect_json "included.?", relationship_data if included
+  end
+
+  def dasherize_keys hash
+    hash.deep_transform_keys { |key| key.to_s.tr('_', '-').to_sym }
+  end
+
+  def jsonapi_match? model, data, type
+    (data[:type] == type) && (data[:id] == model.id.to_s)
+  end
+
+  def jsonapi_type model
+    model.class.to_s.underscore.downcase.pluralize.tr('_', '-')
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_expectations
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Ross-Hunter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: airborne
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.12
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 
+email:
+- ross-hunter@ross-hunter.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jsonapi_expectations.rb
+homepage: https://github.com/Ross-Hunter/jsonapi_expectations
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Semantic expectation helpers for JSON API testing using Airborne and RSpec.
+test_files: []