restful-matchers 0.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MGJiYzQwMGZhNTEyNDIxYjFhZGYxMmVhNzg0ZjNhY2NkMzVlNTVlMg==
-  data.tar.gz: !binary |-
-    YWI1MmMwYWJhMGFmY2FjMTU5MjllMDM5OTRjMjIwZDkyNGVlZTc2OA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    OWQ2MjdlMDBiMzk4N2JlNjk0OTZhNzk3NzA0M2E0YjE3MmNhODc2YWYzMmFh
-    M2M1NjNlYzRlOTJkYzMwYTkyMmQ3OTBkZjAyNDU0M2MwMzA3OTIxZjA2ODQy
-    OTI0ZmNmMjE4ZmUwZDZjZGVlMjc3MjYwYmQxMDY1NzJiMDM2Nzk=
-  data.tar.gz: !binary |-
-    Y2MzMTFhNDg1NGM2N2FkMmUyYjcwNjE3NzMwZmU3ODBkOTRlZTNmOWNkY2Yw
-    YzRlNWJhNmE4NjU4N2Q0ZTRlMDVkNjExZDQ4M2RkYmZjYjVjMjBiMmYyNmY3
-    MjZhMTQzMTRjNmYzNmJjNWNjOWYxNmUzNGVlZjhmYTMzNWYzM2M=
+SHA1:
+  metadata.gz: 17bb149bb591339ab94a2184962ecec34c73c868
+  data.tar.gz: 793b990cfa27d182b7a29b6c2817aaa147f77f86
+SHA512:
+  metadata.gz: d8b21187bf478846242ac79c81989131a577d987d13a49b2b451e44fc8cbdc01b08ea3e41b4639e0691c07a1e91f994f9351d537fd8df6bbc56c054addac0661
+  data.tar.gz: 98a7a1c319fb2e10561d74c1e82b85d5f8e8d24c44e3aea8581f8ccdb5d5b49873c97766429405a82089505424f7ce2311749ee4ae20cb2a186f73e3d5c842f3

data/.gitignore

@@ -0,0 +1 @@
+restful-matchers-*.gem

data/Gemfile

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

data/Gemfile.lock

@@ -7,7 +7,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    coderay (1.0.9)
     diff-lcs (1.2.4)
+    method_source (0.8.1)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
     rake (10.1.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
@@ -17,11 +25,14 @@ GEM
     rspec-expectations (2.14.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
+    slop (3.4.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0)
+  pry (~> 0.9)
+  pry-nav (~> 0.2)
   rake (~> 10.0)
   restful-matchers!

data/README.md

@@ -1,6 +1,6 @@
-# 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)
+# 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 resource links. Currently it supports only JSON representations with 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, like this:
 
 ```json
 {
@@ -26,3 +26,13 @@ describe MyRestfulController do
   end
 end
 ```
+
+## Installation
+
+Add it to the `test` group in your Gemfile and be happy!
+
+```ruby
+group :test do
+  gem 'restful-matchers'
+end
+```

data/lib/restful/matchers/have_restful_json_link.rb

@@ -7,19 +7,20 @@ module RESTful
     # Example:
     #   response.body.should have_json_link("self", "http://example.com")
     #
-    def have_restful_json_link(rel, href)
+    def have_restful_json_link(rel, href = nil)
       HaveRestfulJsonLink.new(rel, href)
     end
+    alias_method :have_link, :have_restful_json_link
 
     class HaveRestfulJsonLink
-      def initialize(rel, href)
+      def initialize(rel, href = nil)
         @rel  = rel
         @href = href
       end
 
-      def matches?(json_string)
-        if links = parse_links(json_string)
-          return links[@rel] == @href
+      def matches?(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")
         end
@@ -42,8 +43,8 @@ module RESTful
         "{ rel: #{@rel}, href: #{@href} }"
       end
 
-      def parse_links(json_string)
-        json = JSON.parse(json_string)
+      def parse_links_from(content)
+        json =  content.is_a?(Hash) ? content : JSON.parse(content)
         links = nil
         if json["links"]
           links = {}

data/restful-matchers.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name    = "restful-matchers"
-  gem.version = "0.1"
+  gem.version = "0.2.0"
 
   gem.authors     = [ "Marcos Hack" ]
   gem.email       = [ "marcoshack@gmail.com" ]
@@ -14,6 +14,8 @@ Gem::Specification.new do |gem|
   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

@@ -1,15 +1,30 @@
 require 'spec_helper'
 
 describe RESTful::Matchers::HaveRestfulJsonLink do
-  before :each do
-    @json_response = open("spec/fixtures/json/resource.json").read
+
+  shared_examples_for "RESTful 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")
+    end
+
+    it "should not find an unexistant link" do
+      @content.should_not have_restful_json_link("foo", "http://bar.com")
+      @content.should_not have_link("foo", "http://bar.com")
+    end
+
+    it "should find a link matching only the rel attribute" do
+      @content.should have_link("self")
+    end
   end
 
-  it "should find a json link" do
-    @json_response.should have_restful_json_link("self", "http://example.com")
+  context "when processing a JSON content" do
+    before(:each) { @content = open("spec/fixtures/json/resource.json").read }
+    it_behaves_like "RESTful Matcher"
   end
 
-  it "should not find an unexistant link" do
-    @json_response.should_not have_restful_json_link("foo", "http://bar.com")
+  context "when processing a parsed JSON" do
+    before(:each) { @content = JSON.parse(open("spec/fixtures/json/resource.json").read) }
+    it_behaves_like "RESTful Matcher"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restful-matchers
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.2.0
 platform: ruby
 authors:
 - Marcos Hack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,34 @@ 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
 email:
 - marcoshack@gmail.com
@@ -70,17 +98,17 @@ 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.0.5
+rubygems_version: 2.0.4
 signing_key: 
 specification_version: 4
 summary: Easily handle RESTful resources in your tests