hal_spec 0.0.1

data/..gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/./version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Luis Borjas"]
+  gem.email         = ["luisfborjas@gmail.com"]
+  gem.description   = %q{TODO: Write a gem description}
+  gem.summary       = %q{TODO: Write a gem summary}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "."
+  gem.require_paths = ["lib"]
+  gem.version       = .::VERSION
+end

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p125@hal_spec"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.16.20 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Luis Borjas
+
+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,119 @@
+# HalSpec
+
+Adds custom matchers for RSpec and step definitions
+for cucumber to validate and inspect [Hypertext Application
+Language](http://stateless.co/hal_specification.html)
+(the json version) responses (i.e. __no xml support is included__). Builds atop
+[json_spec](https://github.com/collectiveidea/json_spec)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hal_spec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hal_spec
+
+## Usage
+
+
+### Rspec
+
+This gem exposes all the matchers and helpers provided by
+`json_spec` (cf. [their
+README](https://github.com/collectiveidea/json_spec)) plus some
+HAL-specific matchers:
+
+* `be_valid_hal`
+
+(the below example assumes use of the
+[Roar](https://github.com/apotonick/roar) gem for the `MovieRepresenter` class just for illustration purposes, it's not necessary at all)
+
+```ruby
+  describe Movie
+    let(:movie){ Movie.create!(title: "2001", cast: [Character.create(name: "HAL"), Character.create(name: "Dave")])  } 
+    
+    context "#to_json" do
+      it "includes the associations" do
+        Movie.extend(MovieRepresenter)
+        movie.to_json should be_valid_hal
+        movie.to_json should have_json_path("_embedded/cast")
+        movie.to_json should have_json_size(2).at_path("_embedded/cast")
+      end
+    end 
+  end
+```
+
+### Cucumber 
+
+In your `env.rb`, add
+
+```ruby
+require "hal_spec/cucumber"
+```
+
+(the `json_spec` gem requires that you define a `last_json` method in
+your support files, but this
+one doesn't, since it also validates headers from the response)
+
+And use the steps in your responses. 
+
+(the example below had the
+[cucumber-api-steps](https://github.com/jayzes/cucumber-api-steps) gem in mind but,
+again, not necessary)
+
+```cucumber
+Feature: Movie API
+  Background:
+    Given the following movies exist:
+      | id | title                 |
+      | 1  | 2001: a space odyssey |
+      | 2  | 2010: odyssey two     |
+    And the following characters exist:
+      | id | name |
+      | 1  | Dave |
+    And character "Dave" appears in "2001: a space odyssey"
+    And character "Dave" appears in "2010: odyssey two"
+  
+  Scenario: Show character endpoint
+    When I send a GET request to "/characters/1"
+    Then the HAL response should be:
+      """
+        {
+          "_links": {
+              "self": {"href": "/characters/1"}
+          }
+          ,"id": 1
+          ,"name": "Dave"
+          ,"_embedded": {
+            "movies": [
+                {
+                   "_links": {"self": {"href": "/movies/1"}}
+                  ,"id": 1
+                  ,"name": "2001: a space odyssey"
+                }
+                ,{
+                   "_links": {"self": {"href": "/movies/2"}}
+                  ,"id": 2
+                  ,"name": "2010: odyssey two"
+                }
+            ]
+          }
+        }
+      """
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :features]

data/features/equivalence.feature

@@ -0,0 +1,11 @@
+Feature: Equivalence 
+  Scenario: Complete HAL
+    Given the HAL is:
+      """
+        {"_links": {"self": {"href": "/lol"}}}
+      """
+    When I get the HAL
+    Then the HAL response should be:
+      """
+        {"_links": {"self": {"href": "/lol"}}}
+      """

data/features/step_definitions/steps.rb

@@ -0,0 +1,17 @@
+require 'rack/test'
+
+World(Rack::Test::Methods)
+
+def app
+  ->(env) do
+    [200, {"Content-Type" => "application/vnd.hal+json", "Content-Length" => @hal.length}, [@hal] || []]
+  end
+end
+
+Given "the HAL is:" do |provided_hal|
+  @hal = provided_hal
+end
+
+When "I get the HAL" do
+  get '/'
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'hal_spec/cucumber'

data/hal_spec.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hal_spec/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Luis Borjas"]
+  gem.email         = ["luisfborjas@gmail.com"]
+  gem.description   = %q{RSpec and Cucumber helpers for HAL}
+  gem.summary       = %q{
+                        Adds custom matchers for RSpec and step definitions
+                        for cucumber to validate and inspect Hypertext Application Language
+                        (+json) responses
+                      }
+  gem.homepage      = "https://github.com/lfborjas/hal_spec"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hal_spec"
+  gem.require_paths = ["lib"]
+  gem.version       = HalSpec::VERSION
+
+  gem.add_dependency "halidator", "~> 0.5"
+
+  gem.add_development_dependency "rspec", "~> 2.0"
+  gem.add_development_dependency "cucumber"
+  gem.add_development_dependency "rack-test"
+end

data/lib/hal_spec.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'halidator'
+require "hal_spec/version"
+require "hal_spec/matchers"
+
+module HalSpec
+  # Your code goes here...
+end

data/lib/hal_spec/cucumber.rb

@@ -0,0 +1,11 @@
+require File.expand_path("../../hal_spec", __FILE__)
+World(HalSpec::Matchers)
+
+Then /the HAL response should be:/ do |whole_or_partial_hal|
+
+  json_body = JSON.parse(last_response.body)
+  json_body.should_not be_nil
+  json_body.should == (JSON.parse(whole_or_partial_hal))
+  last_response.should have_a_valid_hal_content_type
+  last_response.should be_valid_hal
+end

data/lib/hal_spec/matchers.rb

@@ -0,0 +1,26 @@
+require 'hal_spec/matchers/have_a_valid_hal_content_type'
+require 'hal_spec/matchers/be_valid_hal'
+
+module HalSpec
+  module Matchers
+    extend RSpec::Matchers::DSL
+    include HalSpec::Matchers::HaveAValidHalContentType
+    include HalSpec::Matchers::BeValidHal
+
+    matcher :have_a_valid_hal_content_type do 
+      match do |response|
+        has_valid_content_type?(response)
+      end
+    end
+
+    matcher :be_valid_hal do 
+      match do |response|
+        has_valid_body?(response)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include HalSpec::Matchers
+end

data/lib/hal_spec/matchers/be_valid_hal.rb

@@ -0,0 +1,11 @@
+module HalSpec
+  module Matchers
+    module BeValidHal 
+      def has_valid_body?(response)
+        return false unless (response.respond_to?(:body) and !response.body.nil?)
+        JSON.parse(response.body) rescue return false
+        return Halidator.new(response.body).valid?
+      end
+    end
+  end
+end

data/lib/hal_spec/matchers/have_a_valid_hal_content_type.rb

@@ -0,0 +1,14 @@
+module HalSpec
+  module Matchers
+    module HaveAValidHalContentType
+      def has_valid_content_type?(response)
+        response.respond_to?(:headers) or return false
+        response.headers.include?("Content-Type") or return false
+        %w(
+          application/vnd.hal+json
+          application/hal+json
+        ).include?(response.headers["Content-Type"])
+      end
+    end
+  end
+end

data/lib/hal_spec/version.rb

@@ -0,0 +1,3 @@
+module HalSpec
+  VERSION = "0.0.1"
+end

data/spec/hal_spec/matchers/be_valid_hal_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+require 'ostruct'
+require 'json'
+
+def Hal(body)
+  OpenStruct.new(body: JSON.dump(body))
+end
+
+describe HalSpec::Matchers::BeValidHal do
+  let(:minimal_hal){ {_links: {self: {href: "/some/url"}}} }
+
+  context "response prerequisites" do
+    it "should match responses with documented json" do
+      OpenStruct.new(
+        body: '/*this is hal*/{"_links": /*documents are fun!*/{"self": {"href": "/url"}}}'
+      ).should be_valid_hal
+    end
+
+    it "should not match responses without bodies" do
+      OpenStruct.new(bodie: "lel").should_not be_valid_hal
+      OpenStruct.new(body: nil).should_not be_valid_hal
+    end
+
+    it "should not match responses without json bodies" do
+      OpenStruct.new(body: "Yo dawg").should_not be_valid_hal
+    end
+  end
+
+  context "link validation" do
+    it "should match a document with only links" do
+      Hal(minimal_hal).should be_valid_hal
+    end
+
+    it "should match a document with valid links other than self" do
+      json = minimal_hal.dup
+      json[:_links].merge!({search: {href: "/search/{q}", templated: true}})
+      Hal(json).should be_valid_hal
+    end
+
+    it "should match a document with valid links in arrays" do
+      json = minimal_hal.dup
+      json[:_links].merge!({users: [{href: "/users/42"}]})
+      Hal(json).should be_valid_hal
+    end
+
+    it "should match a document with templated links in arrays" do
+      json = minimal_hal.dup
+      json[:_links].merge!({sortings: [{href: "/sort/{dir}", templated: true}]})
+      Hal(json).should be_valid_hal
+    end
+
+    it "should not match a document without links" do
+      Hal({no_links: {self: {href: "/nope"}}}).should_not be_valid_hal
+    end
+
+    it "should not match a document without the self link" do
+      Hal({_links: {lel: {href: "/pah"}}}).should_not be_valid_hal
+    end
+
+    it "should not match a document with invalid link values for self" do
+      Hal({_links: {self: {breh: "/brah"}}}).should_not be_valid_hal
+    end
+
+    it "should not match a document with invalid links for other rels" do
+      json = minimal_hal.dup
+      json[:_links].merge!({search:  "/search/{q}", templated: true})
+      Hal(json).should_not be_valid_hal
+    end
+
+    it "should not match a document with too many self rels" do
+      json = minimal_hal.dup
+      json[:_links].merge!({users: [{self: {href: "/users/4"}},{self: {href: "/users/2"}}]})
+      Hal(json).should_not be_valid_hal
+    end
+
+    it "should not match a document with no href key in arrays" do
+      json = minimal_hal.dup
+      json[:_links].merge!({users: [{bref: "/lel"}]})
+      Hal(json).should_not be_valid_hal
+    end
+
+    it "should not match a document with invalid templates in arrays" do
+      json = minimal_hal.dup
+      json[:_links].merge!({sortings: [
+        {href: "/name", templated: true},
+        {href: "/age/{sort", templated: true},
+        {href: "/age/sort}", templated: true},
+      ]})
+    end
+  end
+
+  context "resource validation" do
+    it "should match a document with embedded resources as an object" do
+      Hal({_embedded: {resources: []}}.merge(minimal_hal)).should be_valid_hal
+    end
+
+    it "should match a document with valid embedded resources" do
+      Hal({_embedded: {resources: 2.times.collect{minimal_hal}}}.merge(minimal_hal)).should be_valid_hal
+    end
+
+    it "should match a document with non-array valid embedded resources" do
+      Hal({
+        _embedded: {user: minimal_hal}
+      }.merge(minimal_hal)).should be_valid_hal
+    end
+
+    it "should match a document with deeply nested valid resources" do
+      valid_hal = minimal_hal
+      json = {
+        _embedded: {
+          user: [{_embedded: {stuff: [valid_hal]}}.merge(valid_hal)]
+        }
+      }.merge(minimal_hal)
+      Hal(json).should be_valid_hal
+    end
+
+    it "should not match a document with deeply nested invalid resources" do
+      Hal({
+        _embedded: {
+          user: [{
+            _embedded: {stuff: [{_links: {self: {lel: "/lol"}}}]}
+          }.merge(minimal_hal)]
+        }
+      }.merge(minimal_hal)).should_not be_valid_hal
+    end
+  end
+end

data/spec/hal_spec/matchers/have_a_valid_hal_content_type_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'ostruct'
+
+describe HalSpec::Matchers::HaveAValidHalContentType do
+  it "matches standard hal content types" do
+    response = OpenStruct.new(headers: {"Content-Type" => "application/vnd.hal+json"})
+    response.should have_a_valid_hal_content_type
+
+    response = OpenStruct.new(headers: {"Content-Type" => "application/hal+json"})
+    response.should have_a_valid_hal_content_type
+  end
+
+  it "doesn't match invalid hal content types" do
+    response = OpenStruct.new(headers: {"Content-Type" => "application/json"})
+    response.should_not have_a_valid_hal_content_type
+  end
+
+  it "doesn't match responses without content types" do
+    response = OpenStruct.new(headers: {})
+    response.should_not have_a_valid_hal_content_type
+
+    response = OpenStruct.new
+    response.should_not have_a_valid_hal_content_type
+  end
+end
+

data/spec/hal_spec/matchers_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe HalSpec::Matchers do
+  context "have_a_valid_hal_content_type" do
+    it "responds to the matcher" do
+      klass = Class.new
+      klass.send(:include, HalSpec::Matchers)
+      klass.new.should respond_to(:have_a_valid_hal_content_type)
+    end
+  end
+
+  context "be_valid_hal" do
+    it "responds to the matcher" do
+      klass = Class.new
+      klass.send(:include, HalSpec::Matchers)
+      klass.new.should respond_to(:be_valid_hal)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "hal_spec"

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: hal_spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Luis Borjas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: halidator
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: RSpec and Cucumber helpers for HAL
+email:
+- luisfborjas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ..gemspec
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/equivalence.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- hal_spec.gemspec
+- lib/hal_spec.rb
+- lib/hal_spec/cucumber.rb
+- lib/hal_spec/matchers.rb
+- lib/hal_spec/matchers/be_valid_hal.rb
+- lib/hal_spec/matchers/have_a_valid_hal_content_type.rb
+- lib/hal_spec/version.rb
+- spec/hal_spec/matchers/be_valid_hal_spec.rb
+- spec/hal_spec/matchers/have_a_valid_hal_content_type_spec.rb
+- spec/hal_spec/matchers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/lfborjas/hal_spec
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Adds custom matchers for RSpec and step definitions for cucumber to validate
+  and inspect Hypertext Application Language (+json) responses
+test_files:
+- features/equivalence.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- spec/hal_spec/matchers/be_valid_hal_spec.rb
+- spec/hal_spec/matchers/have_a_valid_hal_content_type_spec.rb
+- spec/hal_spec/matchers_spec.rb
+- spec/spec_helper.rb