jsonapi-resources-matchers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae0027f2286732ef5034d98b32beb53e5b4f37a1
+  data.tar.gz: 4b8cc9ec1fcbebadeaf8f9acfc6df620f754dd17
+SHA512:
+  metadata.gz: 0596c7a23b1f10d4c088b00744fde0fd5c4dd56918b22fd9b779a35dd472eb54c3deb7968f6501e4d3c2fc454131fdf4031f1a5fb7f22d58f6e6bad712e61af0
+  data.tar.gz: c6c7a07b2aa71a12d01aea8e3d224dd0c9fcf8892edd692419696e1dfb380a77c285a68e657d6a093150c03cc5813e1cc58035fe4e87e184271e0ec4ff4950e1

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-resources-matchers.gemspec
+gemspec
+
+gem 'pry'
+gem 'sqlite3'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ramon Tayag
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 G5
+
+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,67 @@
+# JSONAPI::Resources::Matchers
+
+Spec matchers for [jsonapi-resources](https://github.com/cerebris/jsonapi-resources).
+
+Currently, only RSpec matchers exist.
+
+## Installation
+
+Add this line to your application's Gemfile (in a `test` group):
+
+```ruby
+gem 'jsonapi-resources-matchers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi-resources-matchers
+
+## Usage
+
+Anything with a `type` of `resource` will have the matchers automatically included.
+
+```ruby
+class Book < ActiveResource::Base
+end
+
+class Api::V1::BookResource < JSONAPI::Resource
+  primary_key :isbn
+  attributes :title
+  has_many :readers, class_name: "Person"
+  filters :author_id
+end
+
+RSpec.describe Api::V1::BookResource, type: :resource do
+  let(:book) { Book.new }
+  subject { described_class.new(book) }
+
+  it { is_expected.to use_primary_key :isbn }
+  it { is_expected.to have_attribute :title }
+  it { is_expected.to have_many(:readers).with_class_name("Person") }
+  it { is_expected.to filter(:author_id) }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/g5/jsonapi-resources-matchers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## MIT License
+
+Copyright 2015 G5
+
+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/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/resources/matchers"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jsonapi-resources-matchers.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi/resources/matchers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsonapi-resources-matchers"
+  spec.version       = JSONAPI::Resources::Matchers::VERSION
+  spec.authors       = ["G5", "Ramon Tayag"]
+  spec.email         = ["lateam@getg5.com","ramon.tayag@gmail.com"]
+
+  spec.summary       = %q{Spec matchers for jsonapi-resources}
+  spec.description   = %q{Spec matchers for jsonapi-resources}
+  spec.homepage      = "https://github.com/G5/jsonapi-resources-matchers"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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-resources", ">= 0.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rails"
+end

data/lib/jsonapi-resources-matchers.rb

@@ -0,0 +1 @@
+require 'jsonapi/resources/matchers'

data/lib/jsonapi/resources/matchers.rb

@@ -0,0 +1,36 @@
+require "jsonapi/resources/matchers/version"
+require "jsonapi/resources/matchers/have_attribute"
+require "jsonapi/resources/matchers/filter"
+require "jsonapi/resources/matchers/have_many"
+require "jsonapi/resources/matchers/have_model_name"
+require "jsonapi/resources/matchers/have_primary_key"
+
+module JSONAPI
+  module Resources
+    module Matchers
+
+      def have_attribute(name)
+        HaveAttribute.new(name)
+      end
+
+      def filter(name)
+        Filter.new(name)
+      end
+
+      def have_many(name)
+        HaveMany.new(name)
+      end
+
+      def have_model_name(name)
+        HaveModelName.new(name)
+      end
+
+      def have_primary_key(name)
+        HavePrimaryKey.new(name)
+      end
+
+    end
+  end
+end
+
+require "jsonapi/resources/matchers/integrations/rspec"

data/lib/jsonapi/resources/matchers/filter.rb

@@ -0,0 +1,30 @@
+module JSONAPI
+  module Resources
+    module Matchers
+      class Filter
+
+        attr_accessor :expected_filter_name, :resource
+
+        def initialize(name)
+          self.expected_filter_name = name
+        end
+
+        def matches?(resource)
+          self.resource = resource
+          self.resource.class._allowed_filters.keys.
+            include?(self.expected_filter_name)
+        end
+
+        def description
+          "be able to filter by `#{expected_filter_name}`"
+        end
+
+        def failure_message
+          resource_name = resource.class.name.demodulize
+          %Q(expected #{resource_name} to be able to filter #{expected_filter_name})
+        end
+
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/matchers/have_attribute.rb

@@ -0,0 +1,37 @@
+module JSONAPI
+  module Resources
+    module Matchers
+      class HaveAttribute
+
+        attr_accessor :name, :resource
+
+        def initialize(name)
+          self.name = name
+        end
+
+        def matches?(resource)
+          self.resource = resource
+
+          resource_class = resource.class
+
+          serialized_hash = JSONAPI::ResourceSerializer.new(resource_class).
+            serialize_to_hash(resource).with_indifferent_access
+          expected_key = name.to_s.dasherize
+          attributes = serialized_hash["data"]["attributes"]
+          return false if attributes.nil?
+          attributes.has_key?(expected_key)
+        end
+
+        def failure_message
+          resource_name = resource.class.name.demodulize
+          %Q(expected #{resource_name} to have attribute #{name})
+        end
+
+        def description
+          "have attribute #{name}"
+        end
+
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/matchers/have_many.rb

@@ -0,0 +1,55 @@
+module JSONAPI
+  module Resources
+    module Matchers
+      class HaveMany
+
+        attr_accessor :name, :resource, :expected_class_name
+
+        def initialize(name)
+          self.name = name
+        end
+
+        def description
+          "have many `#{name}`"
+        end
+
+        def matches?(resource)
+          self.resource = resource
+
+          has_key_in_relationships? && matches_class_name?
+        end
+
+        def has_key_in_relationships?
+          serialized_hash = JSONAPI::ResourceSerializer.new(resource.class).
+            serialize_to_hash(resource).with_indifferent_access
+          expected_key = name.to_s.dasherize
+          relationships = serialized_hash["data"]["relationships"]
+          return false if relationships.nil?
+          relationships.has_key?(expected_key)
+        end
+
+        def with_class_name(name)
+          self.expected_class_name = name
+          self
+        end
+
+        def failure_message
+          resource_name = resource.class.name.demodulize
+          message = ["expected `#{resource_name}` to have many `#{name}`"]
+          if self.expected_class_name
+            message << "with class name `#{self.expected_class_name}`"
+          end
+          message.join(" ")
+        end
+
+        def matches_class_name?
+          return true if self.expected_class_name.nil?
+          association = resource.class._relationships[name]
+          actual_class_name = association.class_name
+          self.expected_class_name == actual_class_name
+        end
+
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/matchers/have_model_name.rb

@@ -0,0 +1,29 @@
+module JSONAPI
+  module Resources
+    module Matchers
+      class HaveModelName
+
+        attr_accessor :expected_model_name, :resource
+
+        def initialize(name)
+          self.expected_model_name = name
+        end
+
+        def matches?(resource)
+          self.resource = resource
+          self.resource.class._model_name.to_s == self.expected_model_name.to_s
+        end
+
+        def description
+          %Q(have model name `#{expected_model_name}`)
+        end
+
+        def failure_message
+          resource_name = resource.class.name.demodulize
+          %Q(expected `#{resource_name}` to have the model name `#{expected_model_name}`)
+        end
+
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/matchers/have_primary_key.rb

@@ -0,0 +1,30 @@
+module JSONAPI
+  module Resources
+    module Matchers
+      class HavePrimaryKey
+
+        attr_accessor :expected_primary_key, :resource
+
+        def initialize(name)
+          self.expected_primary_key = name
+        end
+
+        def description
+          "have primary key `#{self.expected_primary_key}`"
+        end
+
+        def matches?(resource)
+          self.resource = resource
+          self.resource.class._primary_key.to_s ==
+            self.expected_primary_key.to_s
+        end
+
+        def failure_message
+          resource_name = resource.class.name.demodulize
+          %Q(expected `#{resource_name}` to use primary key `#{self.expected_primary_key}`)
+        end
+
+      end
+    end
+  end
+end

data/lib/jsonapi/resources/matchers/integrations/rspec.rb

@@ -0,0 +1,5 @@
+if defined?(RSpec)
+  RSpec.configure do |c|
+    c.include JSONAPI::Resources::Matchers, type: :resource
+  end
+end

data/lib/jsonapi/resources/matchers/version.rb

@@ -0,0 +1,7 @@
+module JSONAPI
+  module Resources
+    module Matchers
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-resources-matchers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- G5
+- Ramon Tayag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+description: Spec matchers for jsonapi-resources
+email:
+- lateam@getg5.com
+- ramon.tayag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi-resources-matchers.gemspec
+- lib/jsonapi-resources-matchers.rb
+- lib/jsonapi/resources/matchers.rb
+- lib/jsonapi/resources/matchers/filter.rb
+- lib/jsonapi/resources/matchers/have_attribute.rb
+- lib/jsonapi/resources/matchers/have_many.rb
+- lib/jsonapi/resources/matchers/have_model_name.rb
+- lib/jsonapi/resources/matchers/have_primary_key.rb
+- lib/jsonapi/resources/matchers/integrations/rspec.rb
+- lib/jsonapi/resources/matchers/version.rb
+homepage: https://github.com/G5/jsonapi-resources-matchers
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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
+signing_key: 
+specification_version: 4
+summary: Spec matchers for jsonapi-resources
+test_files: []