restful-matchers 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17bb149bb591339ab94a2184962ecec34c73c868
-  data.tar.gz: 793b990cfa27d182b7a29b6c2817aaa147f77f86
+  metadata.gz: fa23bf113f67c1d2ebcec7749f06a5297fe44ad0
+  data.tar.gz: 2ef8175345a2c7abc59b4f3cc2a0f00b3bcb9bdd
 SHA512:
-  metadata.gz: d8b21187bf478846242ac79c81989131a577d987d13a49b2b451e44fc8cbdc01b08ea3e41b4639e0691c07a1e91f994f9351d537fd8df6bbc56c054addac0661
-  data.tar.gz: 98a7a1c319fb2e10561d74c1e82b85d5f8e8d24c44e3aea8581f8ccdb5d5b49873c97766429405a82089505424f7ce2311749ee4ae20cb2a186f73e3d5c842f3
+  metadata.gz: e694f1dfa908ccdb0292d6f8ffb0c04ce130ee345072c7640ebed3cf2afed1993e2637bd93fb2965c8b93cfd38e76cfd7680684d3ec79c8a6f970db5efb54f4f
+  data.tar.gz: 23bac76446ef247fdcf053e98d65032bca1245b1d6f21b53b0d2eaaf1742bee9fe41730a4cb3a1c419c752336515642e4f673b33652164eed052d2aac92da999

data/.gitignore

@@ -1 +1,3 @@
-restful-matchers-*.gem
+restful-matchers-*.gem
+.bundle
+vendor

data/Gemfile

@@ -2,6 +2,6 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rake", "~> 10.0"
+gem "rake", "~> 10.1"
 gem "pry", "~> 0.9"
-gem "pry-nav", "~> 0.2"
+gem "pry-nav", "~> 0.2"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    restful-matchers (0.1)
+    restful-matchers (0.2.1)
       rspec (~> 2.0)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     coderay (1.0.9)
     diff-lcs (1.2.4)
-    method_source (0.8.1)
+    method_source (0.8.2)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -25,7 +25,10 @@ GEM
     rspec-expectations (2.14.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
-    slop (3.4.5)
+    slop (3.4.6)
+    step-up (0.9.1)
+      thor (>= 0.14.6)
+    thor (0.18.1)
 
 PLATFORMS
   ruby
@@ -34,5 +37,6 @@ DEPENDENCIES
   bundler (~> 1.0)
   pry (~> 0.9)
   pry-nav (~> 0.2)
-  rake (~> 10.0)
+  rake (~> 10.1)
   restful-matchers!
+  step-up (~> 0.9)

data/README.md

@@ -1,6 +1,11 @@
 # restful-matchers [![Build Status](https://travis-ci.org/marcoshack/restful-matchers.png?branch=master)](https://travis-ci.org/marcoshack/restful-matchers) [![Code Climate](https://codeclimate.com/github/marcoshack/restful-matchers.png)](https://codeclimate.com/github/marcoshack/restful-matchers) [![Gem Version](https://badge.fury.io/rb/restful-matchers.png)](http://badge.fury.io/rb/restful-matchers)
 
-RSpec matchers to test RESTful HATEOAS-compliant resource links. Currently it supports only JSON representations as an array of link objects with `rel` and `href` attributes, like this:
+RSpec matchers to test RESTful HATEOAS-compliant resource links. Currently it supports only JSON representations as an array of link objects with `rel` and `href` attributes.
+
+
+## Usage
+
+Given the following JSON response:
 
 ```json
 {
@@ -12,17 +17,20 @@ RSpec matchers to test RESTful HATEOAS-compliant resource links. Currently it su
 }
 ```
 
-Example:
+You can match links represented as an array of `{rel: ... , href: ...}` objects named as `links`:
 
 ```ruby
 describe MyRestfulController do
   render_views
 
-  it "should have entry-point links" do
+  it "should have links" do
     get :index
-    response.body.should have_restful_json_link("self", "http://example.com")
-    response.body.should have_restful_json_link("resource1", "http://example.com/resource1")
-    response.body.should have_restful_json_link("resource2", "http://example.com/resource2")
+    
+    response.body.should have_link "resource1", "http://example.com/resource1"
+    response.body.should have_link "resource2", "http://example.com/resource1"
+
+    parsed_json = JSON.parse(response.body) # you can match both raw or parsed (hash) JSON
+    parsed_json.should have_link "self"     # href attribute is optional
   end
 end
 ```
@@ -32,7 +40,5 @@ end
 Add it to the `test` group in your Gemfile and be happy!
 
 ```ruby
-group :test do
-  gem 'restful-matchers'
-end
+gem 'restful-matchers', '~> 0.2', :group => :test
 ```

data/lib/restful/matchers.rb

@@ -1,4 +1,4 @@
-require "restful/matchers/have_restful_json_link"
+require "restful/matchers/have_link"
 
 if defined?(RSpec)
   require 'restful/matchers/integrations/rspec'

data/lib/restful/matchers/{have_restful_json_link.rb → have_link.rb}

@@ -7,40 +7,37 @@ module RESTful
     # Example:
     #   response.body.should have_json_link("self", "http://example.com")
     #
-    def have_restful_json_link(rel, href = nil)
-      HaveRestfulJsonLink.new(rel, href)
+    def have_link(rel, href = nil)
+      HaveLink.new(rel, href)
     end
-    alias_method :have_link, :have_restful_json_link
+    alias_method :have_restful_json_link, :have_link
 
-    class HaveRestfulJsonLink
+    class HaveLink
       def initialize(rel, href = nil)
         @rel  = rel
         @href = href
       end
 
       def matches?(content)
+        @content = content
         if links = parse_links_from(content)
           return @href ? links[@rel] == @href : links.has_key?(@rel)
         else
-          raise StandardError.new("JSON has no RESTful links")
+          return false
         end
       end
 
       def failure_message_for_should
-        "Expected RESTful link: #{link_representation}"
+        error_message "Expected RESTful link"
       end
 
       def failure_message_for_should_not
-        "Expected no RESTful link: #{link_representation}"
-      end
-
-      def description
-        "have RESTful link: #{link_representation}"
+        error_message "Expected no RESTful link"
       end
 
       private
-      def link_representation
-        "{ rel: #{@rel}, href: #{@href} }"
+      def error_message(message)
+        "#{message} '{\"rel\": \"#{@rel}\", \"href\": \"#{@href || "<any>" }\"}' in '#{@content}'" 
       end
 
       def parse_links_from(content)

data/restful-matchers.gemspec

@@ -2,20 +2,17 @@
 
 Gem::Specification.new do |gem|
   gem.name    = "restful-matchers"
-  gem.version = "0.2.0"
+  gem.version = "0.2.1"
 
   gem.authors     = [ "Marcos Hack" ]
   gem.email       = [ "marcoshack@gmail.com" ]
-  gem.summary     = "Easily handle RESTful resources in your tests"
-  gem.description = "RSpec matchers for testing RESTful resource link representations"
-  gem.homepage    = "https://github.com/marcoshack/rspec-restful-matchers"
+  gem.summary     = "RSpec matchers to test RESTful HATEOAS-compliant resource links."
+  gem.description = "RSpec matchers to test RESTful HATEOAS-compliant resource links. Currently it supports only JSON representations as an array of link objects with rel and href attributes."
+  gem.homepage    = "https://github.com/marcoshack/restful-matchers"
   gem.license     = "MIT"
 
   gem.add_dependency "rspec", "~> 2.0"
-
   gem.add_development_dependency "bundler", "~> 1.0"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "pry-nav"
 
   gem.files         = `git ls-files`.split($\)
   gem.test_files    = gem.files.grep(/^(test)/)

data/spec/restful/matchers/{have_restful_json_link_spec.rb → have_link_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe RESTful::Matchers::HaveRestfulJsonLink do
+describe RESTful::Matchers::HaveLink do
 
-  shared_examples_for "RESTful Matcher" do
+  shared_examples_for "Matcher" do
     it "should find a json link" do
       @content.should have_restful_json_link("self", "http://example.com")
       @content.should have_link("self", "http://example.com")
@@ -20,11 +20,17 @@ describe RESTful::Matchers::HaveRestfulJsonLink do
 
   context "when processing a JSON content" do
     before(:each) { @content = open("spec/fixtures/json/resource.json").read }
-    it_behaves_like "RESTful Matcher"
+    it_behaves_like "Matcher"
   end
 
   context "when processing a parsed JSON" do
     before(:each) { @content = JSON.parse(open("spec/fixtures/json/resource.json").read) }
-    it_behaves_like "RESTful Matcher"
+    it_behaves_like "Matcher"
+  end
+
+  it "should show matched content on fail" do
+    content = '{"foo": "bar", "baz": "qux"}'
+    expect { content.should have_link "self" }.to raise_error(RSpec::Expectations::ExpectationNotMetError, /.*in '#{content}'.*/)
   end
 end
+

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
-require 'restful/matchers'
-
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
 $LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
 
 Dir[File.join(PROJECT_ROOT, 'spec', 'support', '**', '*.rb')].each { |file| require(file) }
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default, :test)
+
+require 'restful/matchers'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful-matchers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marcos Hack
@@ -38,35 +38,9 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-- !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-nav
-  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: RSpec matchers for testing RESTful resource link representations
+description: RSpec matchers to test RESTful HATEOAS-compliant resource links. Currently
+  it supports only JSON representations as an array of link objects with rel and href
+  attributes.
 email:
 - marcoshack@gmail.com
 executables: []
@@ -82,13 +56,13 @@ files:
 - Rakefile
 - lib/restful-matchers.rb
 - lib/restful/matchers.rb
-- lib/restful/matchers/have_restful_json_link.rb
+- lib/restful/matchers/have_link.rb
 - lib/restful/matchers/integrations/rspec.rb
 - restful-matchers.gemspec
 - spec/fixtures/json/resource.json
-- spec/restful/matchers/have_restful_json_link_spec.rb
+- spec/restful/matchers/have_link_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/marcoshack/rspec-restful-matchers
+homepage: https://github.com/marcoshack/restful-matchers
 licenses:
 - MIT
 metadata: {}
@@ -111,5 +85,5 @@ rubyforge_project:
 rubygems_version: 2.0.4
 signing_key: 
 specification_version: 4
-summary: Easily handle RESTful resources in your tests
+summary: RSpec matchers to test RESTful HATEOAS-compliant resource links.
 test_files: []