restful-matchers 0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!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=

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+branches: master
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 10.0"

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    restful-matchers (0.1)
+      rspec (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  rake (~> 10.0)
+  restful-matchers!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2013 Marcos Hack
+
+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,28 @@
+# 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)
+
+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:
+
+```json
+{
+  "attribute1": "value1",
+  "attribute2": "value2",
+  "links": [
+    { "rel": "self", "href": "http://example.com" }
+  ]
+}
+```
+
+Example:
+
+```ruby
+describe MyRestfulController do
+  render_views
+
+  it "should have entry-point 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")
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "spec/**/*_spec.rb"
+  t.rspec_opts = '--color --format progress'
+  t.verbose = false
+end
+
+task :test => [:spec]
+task :default => :test

data/lib/restful-matchers.rb

@@ -0,0 +1 @@
+require 'restful/matchers'

data/lib/restful/matchers.rb

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

data/lib/restful/matchers/have_restful_json_link.rb

@@ -0,0 +1,56 @@
+require 'json'
+
+module RESTful
+  module Matchers
+    # Ensures that JSON response body has the given link.
+    #
+    # Example:
+    #   response.body.should have_json_link("self", "http://example.com")
+    #
+    def have_restful_json_link(rel, href)
+      HaveRestfulJsonLink.new(rel, href)
+    end
+
+    class HaveRestfulJsonLink
+      def initialize(rel, href)
+        @rel  = rel
+        @href = href
+      end
+
+      def matches?(json_string)
+        if links = parse_links(json_string)
+          return links[@rel] == @href
+        else
+          raise StandardError.new("JSON has no RESTful links")
+        end
+      end
+
+      def failure_message_for_should
+        "Expected RESTful link: #{link_representation}"
+      end
+
+      def failure_message_for_should_not
+        "Expected no RESTful link: #{link_representation}"
+      end
+
+      def description
+        "have RESTful link: #{link_representation}"
+      end
+
+      private
+      def link_representation
+        "{ rel: #{@rel}, href: #{@href} }"
+      end
+
+      def parse_links(json_string)
+        json = JSON.parse(json_string)
+        links = nil
+        if json["links"]
+          links = {}
+          json["links"].each { |link| links[link["rel"]] = link["href"] }
+        end
+        return links
+      end
+    end
+  end
+end

data/lib/restful/matchers/integrations/rspec.rb

@@ -0,0 +1,6 @@
+require 'rspec/core'
+require 'restful/matchers'
+
+RSpec.configure do |config|
+  config.include RESTful::Matchers
+end

data/restful-matchers.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+  gem.name    = "restful-matchers"
+  gem.version = "0.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.license     = "MIT"
+
+  gem.add_dependency "rspec", "~> 2.0"
+
+  gem.add_development_dependency "bundler", "~> 1.0"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(/^(test)/)
+  gem.require_paths = ["lib"]
+end

data/spec/fixtures/json/resource.json

@@ -0,0 +1,7 @@
+{
+  "attr1": "value1",
+  "attr2": "value2",
+  "links": [
+    { "rel": "self", "href": "http://example.com" }
+  ]
+}

data/spec/restful/matchers/have_restful_json_link_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe RESTful::Matchers::HaveRestfulJsonLink do
+  before :each do
+    @json_response = open("spec/fixtures/json/resource.json").read
+  end
+
+  it "should find a json link" do
+    @json_response.should have_restful_json_link("self", "http://example.com")
+  end
+
+  it "should not find an unexistant link" do
+    @json_response.should_not have_restful_json_link("foo", "http://bar.com")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+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) }

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: restful-matchers
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Marcos Hack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: RSpec matchers for testing RESTful resource link representations
+email:
+- marcoshack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/restful-matchers.rb
+- lib/restful/matchers.rb
+- lib/restful/matchers/have_restful_json_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/spec_helper.rb
+homepage: https://github.com/marcoshack/rspec-restful-matchers
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Easily handle RESTful resources in your tests
+test_files: []