rspec-hal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05575f5807ab23396a769f90057ba719283a0d1c
+  data.tar.gz: a01215a9b71a86782bb009d377b6dbf4f32a366f
+SHA512:
+  metadata.gz: b387994d1f7113fbaaa5f03579a90937823f0289f22d14ea3c4ce86b84473a6cc9dee2daf71905055a05493adad6074da7ee5472395e2ca1a6b1282927af081a
+  data.tar.gz: 7b58f38974355b33e8238a95684d09a1de7f8777644418b949fba69eb19156c1a8116bfab257b7f79abb15db24d2b316e55cda33b74f852364484b1c56ec1c8c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.1"
+  - jruby-19mode # JRuby in 1.9 mode

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+#gem "rspec", "~>2.14"
+gem "rspec", "~>3.0.0.beta"
+
+# Specify your gem's dependencies in rspec-hal.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Williams
+
+MIT License
+
+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,63 @@
+[![Build Status](https://travis-ci.org/pezra/hal-interpretation.png?branch=master)](https://travis-ci.org/pezra/hal-interpretation)
+[![Code Climate](https://codeclimate.com/github/pezra/hal-interpretation.png)](https://codeclimate.com/github/pezra/hal-interpretation)
+
+# Rspec Hal
+
+Provides matchers and convenience methods for verifying HAL documents.
+
+## Usage
+
+Include the matchers by adding this to your spec_helper
+
+```ruby
+RSpec.configuration.include RSpec::Hal::Matchers::Documents
+```
+
+(Don't forget to `require rspec-hal` if you are not using bundler.)
+
+If you are using rspec-rails and want only include the matchers for views do this
+
+```ruby
+RSpec.configuration.include RSpec::Hal::Matchers::Documents, type: 'view'
+```
+
+Once you have the matchers included you can use it like this
+
+```ruby
+    expect(a_user_doc).to be_hal
+
+    expect(first_page_of_users).to be_hal_collection
+
+    expect(a_user_doc).to have_property "name"
+    expect(a_user_doc).to have_property('name').matching(/ice$/)
+    expect(a_user_doc).to have_property('name').matching(end_with('ice'))
+    expect(a_user_doc).to have_property('hobbies')
+      .including(a_hash_including('type' => 'sport'))
+
+    expect(a_user_doc).to have_relation('tag')
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-hal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-hal
+
+## Contributing
+
+1. Fork it ( http://github.com/pezra/rspec-hal/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes and `lib/rspec/hal/version.rb` following [semver][] rules
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+[semver]: http://semver.org

data/Rakefile

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

data/lib/rspec-hal.rb

@@ -0,0 +1 @@
+require "rspec/hal.rb"

data/lib/rspec/hal.rb

@@ -0,0 +1,7 @@
+require "rspec/hal/version"
+
+module RSpec
+  module Hal
+    autoload :Matchers, "rspec/hal/matchers"
+  end
+end

data/lib/rspec/hal/matchers.rb

@@ -0,0 +1,118 @@
+require 'json'
+require 'hal-client'
+
+module RSpec
+  module Hal
+    module Matchers
+      module Document
+        extend RSpec::Matchers::DSL
+
+        # Provide a 3.0 compatible DSL methods for 2.x RSpec.
+        module ForwardCompat
+          def failure_message(&blk)
+            failure_message_for_should(&blk)
+          end
+        end
+
+        # Install 3.0 compatibility layer if needed.
+        class << self
+          def matcher(name, &blk)
+            super name do |*args|
+              extend ForwardCompat unless respond_to? :failure_message
+
+              self.instance_exec *args, &blk
+            end
+          end
+        end
+
+
+        # Check that the document provided is a valid HAL document.
+        #
+        # Signature
+        #
+        #     expect(a_user_doc).to be_hal
+        matcher :be_hal do
+          match do |a_json_doc|
+             !!(JSON.load(a_json_doc) rescue false)
+          end
+
+          failure_message do |a_json_doc|
+            message = begin
+                        JSON.load(a_json_doc)
+                      rescue err
+                        err.message
+                      end
+            message + " while parsing:\n" + a_json_doc
+          end
+        end
+
+        # Check that the document is both a valid HAL document and is
+        # a page of an RFC 6573 collection
+        #
+        # Signature
+        #
+        #     expect(first_users_page).to be_hal_collection
+        matcher :be_hal_collection do
+          match do |a_doc|
+            a_doc = JSON.load(a_doc) rescue a_doc
+
+            a_doc.fetch("_embedded").has_key?("item") rescue false
+          end
+
+          failure_message do |a_doc|
+            "Expected `$._embedded.item` to exist in:\n" + a_doc
+          end
+        end
+
+        # Check that the document has the specified property.
+        #
+        # Signature
+        #
+        #     expect(a_user_doc).to have_property "name"
+        #     expect(a_user_doc).to have_property("name").matching(/bob/i)
+        #     expect(a_user_doc).to have_property("hobbies").including(matching("golf"))
+        matcher :have_property do |prop_name|
+          match do |a_doc|
+            a_doc = JSON.load(a_doc) rescue a_doc
+
+
+            next false unless a_doc.key? prop_name
+
+            __value_matcher === a_doc.fetch(prop_name)
+          end
+
+          chain :matching do |val_pat|
+            @value_matcher = val_pat
+          end
+
+          chain :including do |val_pat|
+            @value_matcher = RSpec::Matchers::BuiltIn::Include.new val_pat
+          end
+
+          define_method(:__value_matcher) do
+            @value_matcher ||=  ->(*_){ true }
+          end
+        end
+
+        # Check that the document has the specified relation (in
+        # either the _links or _embedded sections.
+        #
+        # Signature
+        #
+        #     expect(a_user_doc).to have_relation "tag"
+        matcher :have_relation do |link_rel|
+          match do |a_doc|
+            a_doc = JSON.load(a_doc) rescue a_doc
+            repr = HalClient::Representation.new(parsed_json: a_doc)
+
+            begin
+              repr.related_hrefs(link_rel).any?
+            rescue KeyError
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rspec/hal/matchers_spec.rb

@@ -0,0 +1,5 @@
+require_relative "../../../spec_helper"
+
+describe RSpec::Hal::Matchers do
+
+end

data/lib/rspec/hal/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module Hal
+    VERSION = "0.0.1"
+  end
+end

data/rspec-hal.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/hal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-hal"
+  spec.version       = RSpec::Hal::VERSION
+  spec.authors       = ["Peter Williams"]
+  spec.email         = ["pezra@barelyenough.org"]
+  spec.summary       = %q{Matchers and helpers for specing HAL documents.}
+  spec.homepage      = "http://github.com/pezra/rspec-hal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+
+  spec.add_runtime_dependency "rspec", [">= 2.0", "< 4.0"]
+  spec.add_runtime_dependency "hal-client", "~> 2.2
+"
+end

data/spec/rspec/hal/matchers_spec.rb

@@ -0,0 +1,91 @@
+require_relative "../../spec_helper"
+
+describe RSpec::Hal::Matchers::Document do
+  describe "be_hal" do
+    subject(:matcher) { be_hal }
+
+    specify { expect(matcher.matches?(hal_doc)).to be true }
+    specify { expect(matcher.matches?("What's HAL?")).to be false }
+  end
+
+  describe "be_hal_collection" do
+    subject(:matcher) { be_hal_collection }
+
+    specify { expect(matcher.matches?(hal_collection)).to be true }
+    specify { expect(matcher.matches?("What's HAL?")).to be false }
+    specify { expect(matcher.matches?(hal_doc)).to be false }
+  end
+
+  describe "have_property('name')" do
+    subject(:matcher) { have_property('name') }
+
+    specify { expect(matcher.matches?(hal_doc)).to be true}
+    specify { expect(matcher.matches?("{}")).to be false}
+  end
+
+  describe "have_property('name').matching(/ice$/)" do
+    subject(:matcher) { have_property('name').matching(/ice$/) }
+
+    specify { expect(matcher.matches?(hal_doc)).to be true}
+    specify { expect(matcher.matches?("{}")).to be false}
+    specify { expect(matcher.matches?(bob)).to be false}
+  end
+
+  describe "have_property('name').matching(end_with('ice'))" do
+    subject(:matcher) { have_property('name')
+        .matching(RSpec::Matchers::BuiltIn::EndWith.new("ice")) }
+
+    specify { expect(matcher.matches?(hal_doc)).to be true}
+    specify { expect(matcher.matches?("{}")).to be false}
+    specify { expect(matcher.matches?(bob)).to be false}
+  end
+
+  describe "have_property('hobbies').including(a_hash_including('type' => 'sport'))" do
+    subject(:matcher) { have_property('hobbies')
+        .including(RSpec::Matchers::BuiltIn::Include.new('type' => 'sport')) }
+    before do extend described_class end
+
+    specify { expect(matcher.matches?(hal_doc)).to be true}
+    specify { expect(matcher.matches?("{}")).to be false}
+    specify { expect(matcher.matches?(bob)).to be false}
+  end
+
+  describe "have_relation('tag')" do
+    subject(:matcher) { have_relation('tag') }
+
+    specify { expect(matcher.matches?(hal_doc)).to be true}
+    specify { expect(matcher.matches?("{}")).to be false}
+    specify { expect(matcher.matches?(bob)).to be false}
+  end
+
+
+  before do
+    extend RSpec::Hal::Matchers::Document
+  end
+
+  let(:hal_collection) { <<-HAL }
+    { "_embedded": { "item": [
+          #{hal_doc}
+    ]}}
+  HAL
+  let(:hal_doc) { <<-HAL }
+    { "name": "Alice"
+      ,"hobbies": [{"type": "sport", "name": "golf"}]
+      ,"_links": {
+        "tag": [{ "href": "http://tags.example.com/smart" }]
+      }
+      ,"_embedded": {
+        "http://rel.example.com/boss_of": #{bob}
+      }
+    }
+  HAL
+  let(:bob) { <<-HAL }
+    { "name": "Bob"
+      ,"_links": {
+        "self": { "href": "http://example.com/users/42" }
+      }
+      ,"_embedded": {
+      }
+    }
+  HAL
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "rspec-hal"

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rspec-hal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hal-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: 
+email:
+- pezra@barelyenough.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-hal.rb
+- lib/rspec/hal.rb
+- lib/rspec/hal/matchers.rb
+- lib/rspec/hal/matchers_spec.rb
+- lib/rspec/hal/version.rb
+- rspec-hal.gemspec
+- spec/rspec/hal/matchers_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pezra/rspec-hal
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Matchers and helpers for specing HAL documents.
+test_files:
+- spec/rspec/hal/matchers_spec.rb
+- spec/spec_helper.rb