rspec-api-matchers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79c751c1af951762a1fe11184842ac7959b4e43a
+  data.tar.gz: c7b91641ccb763315b14cc0e2eadf2e4651a5fe8
+SHA512:
+  metadata.gz: ce34b69d0059e0a5af071de68fe64340066b726c984c71f86213edb1ca6995d7250a97b28b3c081572325fd91af6e1dbb4418db310362bb87b7dbcb05a19d731
+  data.tar.gz: 23abd33b373b5bbd6676a5a9ae10d6a1ae7c97b228ec182c250c81cae0c14d8bc8f173e4909c663883536fb4809baf257c9cb1661b6d8f0dbc971d7f141c9012

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 claudiob
+
+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,30 @@
+RSpec API Matchers
+==================
+
+RSpecApi::Matchers lets you express outcomes on the response of web APIs.
+
+    expect(404).to match_status(:not_found)
+
+More documentation and examples about RSpec Api are available at [http://rspec-api.github.io](http://rspec-api.github.io)
+
+[![Build Status](https://travis-ci.org/rspec-api/rspec-api-matchers.png)](https://travis-ci.org/rspec-api/rspec-api-matchers)
+[![Code Climate](https://codeclimate.com/github/rspec-api/rspec-api-matchers.png)](https://codeclimate.com/github/rspec-api/rspec-api-matchers)
+[![Coverage Status](https://coveralls.io/repos/rspec-api/rspec-api-matchers/badge.png)](https://coveralls.io/r/rspec-api/rspec-api-matchers)
+[![Dependency Status](https://gemnasium.com/rspec-api/rspec-api-matchers.png)](https://gemnasium.com/rspec-api/rspec-api-matchers)
+
+Install
+-------
+
+Add `gem 'rspec-api-matchers'` to your `Gemfile` and run `bundle`.
+Or install yourself by running `gem install rspec-api-matchers`.
+
+Available matchers
+------------------
+
+    expect(http_status_code).to match_status(http_status)
+
+How to contribute
+=================
+
+Don’t hesitate to send me code comments, issues or pull requests through GitHub!
+All feedback is appreciated. Thanks :)

data/lib/rspec-api-matchers.rb

@@ -0,0 +1 @@
+require 'rspec-api/matchers'

data/lib/rspec-api/matchers.rb

@@ -0,0 +1,3 @@
+require 'rspec-api/matchers/version'
+require 'rspec-api/matchers/matchers'
+require 'rspec-api/matchers/match_status'

data/lib/rspec-api/matchers/match_status.rb

@@ -0,0 +1,60 @@
+require 'rack/utils'
+
+module RSpecApi
+  module Matchers
+    class MatchStatus
+      def initialize(expected_status)
+        @expected_status = expected_status
+      end
+
+      def matches?(actual_code)
+        @actual_code = actual_code
+        actual_code == expected_code
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        "expected #{@actual_code} to #{description}"
+      end
+
+      def failure_message_for_should_not
+        "expected #{@actual_code} not to #{description}"
+      end
+
+      def description
+        "be #{@expected_status}"
+      end
+
+    private
+
+      def expected_code
+        status_to_numeric_code @expected_status
+      end
+
+      # Translates an HTTP status symbol or code into the corresponding code
+      #
+      # @example
+      # status_to_code(:ok) # => 200
+      # status_to_code(200) # => 200
+      # status_to_code(987) # => raise
+      def status_to_numeric_code(status)
+        code = status.is_a?(Symbol) ? Rack::Utils.status_code(status) : status
+        validate_status_code! code
+        code
+      end
+
+      # Raises an exception if +numeric_code+ is not a valid HTTP status code
+      #
+      # @example
+      # validate_status_code!(200) # => (no error)
+      # validate_status_code!(999) # => raise
+      def validate_status_code!(code)
+        valid_codes = Rack::Utils::SYMBOL_TO_STATUS_CODE.values
+        message = "#{code} must be a valid HTTP status code: #{valid_codes}"
+        unless valid_codes.include? code
+          raise ArgumentError, message
+        end
+      end
+    end
+  end
+end

data/lib/rspec-api/matchers/matchers.rb

@@ -0,0 +1,26 @@
+require 'rspec/matchers'
+
+module RSpecApi
+  module Matchers
+    # Passes if receiver is the same HTTP status code as the argument.
+    # The receiver can either be in a symbolic or numeric form.
+    #
+    # @example
+    #
+    #   # Passes if 200 corresponds to 200
+    #   expect(200).to match_status(200)
+    #
+    #   # Passes if :ok corresponds to :ok
+    #   expect(:ok).to match_status(200)
+    def match_status(expected_status)
+      RSpecApi::Matchers::MatchStatus.new(expected_status)
+    end
+  end
+end
+
+module RSpec
+  module Matchers
+    # Make RSpecApi::Matchers available inside RSpec
+    include ::RSpecApi::Matchers
+  end
+end

data/lib/rspec-api/matchers/version.rb

@@ -0,0 +1,5 @@
+module RSpecApi
+  module Matchers
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rspec-api-matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- claudiob
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: coveralls
+  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 useful to test web APIs.
+email:
+- claudiob@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rspec-api/matchers/match_status.rb
+- lib/rspec-api/matchers/matchers.rb
+- lib/rspec-api/matchers/version.rb
+- lib/rspec-api/matchers.rb
+- lib/rspec-api-matchers.rb
+- MIT-LICENSE
+- README.md
+homepage: https://github.com/rspec-api/rspec-api-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: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: Methods extracted from rspec-api to chech validity of the response of pragmatic
+  RESTful web APIs.
+test_files: []