rspec-api-matchers 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79c751c1af951762a1fe11184842ac7959b4e43a
-  data.tar.gz: c7b91641ccb763315b14cc0e2eadf2e4651a5fe8
+  metadata.gz: 480e18da2657efd7c3645a753ce1cc105c8bd4d4
+  data.tar.gz: fb4600f19714aa5eb6f0a49b4e45bcc05be3d1ca
 SHA512:
-  metadata.gz: ce34b69d0059e0a5af071de68fe64340066b726c984c71f86213edb1ca6995d7250a97b28b3c081572325fd91af6e1dbb4418db310362bb87b7dbcb05a19d731
-  data.tar.gz: 23abd33b373b5bbd6676a5a9ae10d6a1ae7c97b228ec182c250c81cae0c14d8bc8f173e4909c663883536fb4809baf257c9cb1661b6d8f0dbc971d7f141c9012
+  metadata.gz: dfc14d736db8c6d4f9c059d32ab0012c579c585a2b903ae2cf8920211be1ed95f5b42c07e4d56a710c8357df97d50fb7539ee8ea97d05bc030f2c8846adca79b
+  data.tar.gz: 12d82522d32fb0154b6e5e7c20464a2c01e47b4adb863a2475db3aa0ca8a584db430afb1ba84556240b8ab76398bf2b1a911f88d9b2196578f5a42137e7850a7

data/README.md

@@ -3,11 +3,11 @@ RSpec API Matchers
 
 RSpecApi::Matchers lets you express outcomes on the response of web APIs.
 
-    expect(404).to match_status(:not_found)
+    expect(response).to have_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)
+[![Build Status](https://travis-ci.org/rspec-api/rspec-api-matchers.png?branch=master)](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)
@@ -21,7 +21,14 @@ Or install yourself by running `gem install rspec-api-matchers`.
 Available matchers
 ------------------
 
-    expect(http_status_code).to match_status(http_status)
+    expect(response).to have_status(:ok)
+    expect(response).to include_content_type(:json)
+    expect(response).to have_prev_page_link
+    expect(response).to be_valid_json(Array)
+    expect(response).to be_a_jsonp('alert')
+    expect(response).to be_sorted(by: :id, verse: :desc)
+    expect(response).to be_filtered(10, by: :id)
+    expect(response).to have_attributes(id: {value: 1.2}, url: {type: {string: :url}})
 
 How to contribute
 =================

data/lib/rspec-api/dsl/be_a_jsonp.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/jsonp'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is in JSONP format
+      #
+      # @note
+      #
+      # A JSONP should actually return application/javascript...
+      #
+      # @example
+      #
+      #   # Passes if the body is a JSON wrapped in a callback
+      #   body = 'alert([{"website":"http://www.example.com","flag":null}])'
+      #   expect(OpenStruct.new body: body).to be_a_jsonp(:alert)
+      def be_a_jsonp(callback = nil)
+        RSpecApi::Matchers::Jsonp.new(callback)
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/be_filtered.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/filter'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is filtered by +options[:by]+ comparing with +options[:comparing_with]+
+      #
+      # @example
+      #
+      #   # Passes if the body only contains ID = 1
+      #   body = '[{"id": 1}, {"id": 1}, {"id": 1}]'
+      #   expect(OpenStruct.new body: body).to be_filtered(1, by: :id)
+      #
+      #   # Passes if the body only contains ID < 10
+      #   body = '[{"id": 1}, {"id": 6}, {"id": 3}]'
+      #   expect(OpenStruct.new body: body).to be_filtered(10, by: :id, comparing_with: :<)
+      def be_filtered(value = nil, options = {})
+        RSpecApi::Matchers::Filter.new value, options
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/be_sorted.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/sort'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is sorted by +options[:by]+ with +options[:verse]+
+      #
+      # @example
+      #
+      #   # Passes if the body is sorted by ascending IDs
+      #   body = '[{"id": 1}, {"id": 2}, {"id": 3}]'
+      #   expect(OpenStruct.new body: body).to be_sorted(by: :id)
+      #
+      #   # Passes if the body is sorted by descending timestamps
+      #   body = '[{"t": "2013-10-29T18:09:43Z"}, {"t": "2009-01-12T18:09:43Z"}]'
+      #   expect(OpenStruct.new body: body).to be_sorted(by: :t, verse: :desc)
+      def be_sorted(options = {})
+        RSpecApi::Matchers::Sort.new options
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/be_valid_json.rb

@@ -0,0 +1,29 @@
+require 'rspec-api/matchers/json'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is JSON. Optionally check if Array or Hash.
+      # Skips if  if response body is JSON. Optionally check if Array or Hash.
+      #
+      # @example
+      #
+      #   # Passes if the body is valid JSON
+      #   body = '{"id": 1}'
+      #   expect(OpenStruct.new body: body).to be_valid_json
+      #
+      #   # Passes if the body is a valid JSON-marshalled Hash
+      #   body = '{"id": 1}'
+      #   expect(OpenStruct.new body: body).to be_valid_json(Hash)
+      #
+      #   # Passes if the body is a valid JSON-marshalled Array
+      #   body = '[{"id": 1}, {"id": 2}]'
+      #   expect(OpenStruct.new body: body).to be_valid_json(Array)
+      def be_valid_json(type = nil)
+        RSpecApi::Matchers::Json.new(type)
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/have_attributes.rb

@@ -0,0 +1,37 @@
+require 'rspec-api/matchers/attributes'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response body is an object or array of objects with +key+.
+      #
+      # @example
+      #
+      #   # Passes if the body is an object with key :id
+      #   body = '{"id": 1, "url": "http://www.example.com"}'
+      #   expect(OpenStruct.new body: body).to have_attributes(:id)
+      #
+      #   # Passes if the body is an object with key :id and value 1
+      #   body = '{"id": 1, "url": "http://www.example.com"}'
+      #   expect(OpenStruct.new body: body).to have_attributes(id: {value: 1})
+      #
+      #   # Passes if the body is an array of objects, all with key :id
+      #   body = '{"id": 1, "name": ""}, {"id": 2}]'
+      #   expect(OpenStruct.new body: body).to have_attributes(:id)
+      #
+      #   # Passes if the body is an array of object with key :id and odd values
+      #   body = '{"id": 1, "name": ""}, {"id": 3}], {"id": 5}]'
+      #   expect(OpenStruct.new body: body).to have_attributes(id: {value: -> v {v.odd?}})
+
+      # TODO: add &block options
+      def have_attributes(attributes = {})
+        RSpecApi::Matchers::Attributes.new attributes
+      end
+      # alias have_attribute have_attributes
+      # alias have_keys have_attributes
+      # alias have_key have_attributes
+    end
+  end
+end

data/lib/rspec-api/dsl/have_prev_page_link.rb

@@ -0,0 +1,20 @@
+require 'rspec-api/matchers/prev_page_link'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response includes the pagination Link rel=prev in the headers
+      #
+      # @example
+      #
+      #   # Passes if the headers specify the pagination link for Prev
+      #   headers = {'Link' => '<https://example.com/1>; rel="prev"'}
+      #   expect(OpenStruct.new headers: headers).to have_prev_page_link
+      def have_prev_page_link
+        RSpecApi::Matchers::PrevPageLink.new
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/have_status.rb

@@ -0,0 +1,20 @@
+require 'rspec-api/matchers/status'
+
+module RSpecApi
+  module Matchers
+    module DSL
+      # Passes if response has the given HTTP status code.
+      #
+      # @example
+      #
+      #   # Passes if the status is 200 OK (passed as a symbol)
+      #   expect(OpenStruct.new status: 200).to match_status :ok
+      #
+      #   # Passes if the status is 200 OK (passed as a number)
+      #   expect(OpenStruct.new status: 200).to match_status 200
+      def have_status(status)
+        RSpecApi::Matchers::Status.new status
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/include_content_type.rb

@@ -0,0 +1,23 @@
+require 'rspec-api/matchers/content_type'
+
+module RSpecApi
+  module Matchers
+    # Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+    # makes RSpecApi::Matchers::Status available as expect(...).to match_status
+    module DSL
+      # Passes if response includes the given Content-Type JSON in the headers
+      #
+      # @example
+      #
+      #   # Passes if the headers specify that Content-Type is JSON
+      #   headers ={'Content-Type' => 'application/json; charset=utf-8'}
+      #   expect(OpenStruct.new headers: headers).to include_content_type(:json)
+      def include_content_type(type = nil)
+        content_type = case type
+        when :json then 'application/json; charset=utf-8'
+        end
+        RSpecApi::Matchers::ContentType.new(content_type)
+      end
+    end
+  end
+end

data/lib/rspec-api/dsl/run_if.rb

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/run_if'
+
+module RSpecApi
+  module Matchers
+    module DSL
+      # Creates a +method_name+_if method for each DSL method
+      #
+      # @example
+      #
+      # def have_prev_page_link_if(condition, *args)
+      #   RSpecApi::Matchers::RunIf.new condition, have_prev_page_link(*args)
+      # end
+      RSpecApi::Matchers::DSL.instance_methods.each do |method|
+        define_method("#{method}_if") do |condition, *args|
+          run_if condition, send(method, *args)
+        end
+      end
+
+      def run_if(run, matcher)
+        RSpecApi::Matchers::RunIf.new run, matcher
+      end
+    end
+  end
+end

data/lib/rspec-api/matchers.rb

@@ -1,3 +1,28 @@
-require 'rspec-api/matchers/version'
-require 'rspec-api/matchers/matchers'
-require 'rspec-api/matchers/match_status'
+require 'rspec-api/dsl/have_status'
+require 'rspec-api/dsl/include_content_type'
+require 'rspec-api/dsl/have_prev_page_link'
+require 'rspec-api/dsl/be_a_jsonp'
+require 'rspec-api/dsl/be_sorted'
+require 'rspec-api/dsl/be_valid_json'
+require 'rspec-api/dsl/be_filtered'
+require 'rspec-api/dsl/have_attributes'
+require 'rspec-api/dsl/run_if' # should be the last, for metaprogramming
+
+require 'rspec/matchers'
+
+# Convert RSpecAPI::Matchers classes into RSpec-compatible matchers, e.g.:
+# makes RSpecApi::Matchers::Status available as expect(...).to match_status
+
+module RSpecApi
+  module Matchers
+    module DSL
+    end
+  end
+end
+
+module RSpec
+  module Matchers
+    # Make RSpecApi::Matchers::DSL methods available inside RSpec
+    include ::RSpecApi::Matchers::DSL
+  end
+end

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

@@ -0,0 +1,171 @@
+require 'json'
+require 'active_support/core_ext/array/wrap'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/array/conversions'
+
+module RSpecApi
+  module Matchers
+    class Attributes
+      def initialize(attributes = {})
+        @attributes = as_hash(attributes)
+      end
+
+      def matches?(response)
+        @body = response.body
+        json = extract_symbolized_json_from @body
+        # NOTE: Might add this... but might be too strict. For instance, if I
+        # ask for ?page=2, I might get an empty array. Maybe in that case I
+        # should not even check for attributes? Maybe it can be another best
+        # practice: adding query params will not affect the attributes (so I
+        # can just check them when there are no query params)... of course
+        # unless the query params is ?fields=id,name
+        # if json.is_a?(Array) and json.empty?
+        #   raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is sorted, but the array is empty. Try with more fixtures"
+        # end
+        has_attributes? json, @attributes
+      rescue JSON::ParserError, JSON::GeneratorError
+        false
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        "expected body to #{description}, but got #{@body}"
+      end
+
+      def failure_message_for_should_not
+        "expected body not to #{description}, but it did"
+      end
+
+      def description
+        desc = @attributes.map do |name, options|
+          text = "#{name}"
+          if options.key?(:value)
+            text << "="
+            text << case options[:value]
+              when NilClass then 'nil'
+              when Proc then '[Proc value]'
+              else "#{options[:value]}"
+            end
+          end
+          if options.key?(:type)
+            expected_types = Array.wrap(options.fetch :type, :any)
+            types = expected_types.map do |type|
+              case type
+              when Hash
+                type.map do |k, format|
+                  case format
+                  when Hash, Array
+                    "#{k} with attributes"
+                  else # Symbol
+                    "#{format} #{k}"
+                  end
+                end.to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')
+              else "#{type}"
+              end
+            end
+            text << " (#{types.to_sentence(two_words_connector: ' or ', last_word_connector: ', or ')})" if types.any?
+          end
+          text
+        end.to_sentence
+        ['have attributes', desc].join(' ').strip
+      end
+
+    private
+
+      def has_attributes?(item_or_items, attributes)
+        attributes.deep_symbolize_keys!
+        items = Array.wrap item_or_items
+        attributes.all? do |name, options|
+          has_attribute? items, name, options
+        end
+      end
+
+      def has_attribute?(items, name, options)
+        if items.all?{|item| has_key? item, name}
+          values = items.map{|item| item[name]}
+          expected_types = Array.wrap(options.fetch :type, :any)
+          expected_value = options.fetch :value, :any
+          values.all? do |value|
+            matches_value?(value, expected_value) && matches_types?(value, expected_types)
+          end
+        end
+      end
+
+      def has_key?(item, name)
+        item.key? name
+      end
+
+
+      def matches_value?(value, expected_value)
+        case expected_value
+        when :any then true
+        when Proc then expected_value.call value
+        else value == expected_value
+        end
+      end
+
+      def matches_types?(value, expected_types)
+        expected_types.any? do |type|
+          matches_type_and_format? value, type
+        end
+      end
+
+      def matches_type_and_format?(value, type)
+        type = Hash[type, :any] unless type.is_a?(Hash)
+        type.any? do |type, format|
+          matches_type?(value, type) && matches_format?(value, format)
+        end
+      end
+
+      def matches_type?(value, type)
+        type_to_classes(type).any?{|klass| value.is_a? klass}
+      end
+
+      def matches_format?(value, format)
+        case format
+        when :url then value =~ URI::regexp
+        when :integer then value.is_a? Integer
+        when :timestamp then DateTime.iso8601 value rescue false
+        when :email then value =~ %r{(?<name>.+?)@(?<host>.+?)\.(?<domain>.+?)}
+        when Hash, Array then value.any? ?has_attributes?(value, as_hash(format)) : true
+        when String then matches_format?(value, format.to_sym)
+        when :any then true
+        end
+      end
+
+      def type_to_classes(type)
+        Array.wrap case type
+          when :string then String
+          when :array then Array
+          when :object then Hash
+          when :null then NilClass
+          when :boolean then [TrueClass, FalseClass]
+          when :number then Numeric
+          when String then type_to_classes(type.to_sym)
+          when :any then Object
+        end
+      end
+
+      # These go elsewhere
+
+      def as_hash(anything)
+        if anything.is_a? Hash
+          anything
+        elsif anything.nil?
+          {}
+        else
+          Hash[*Array.wrap(anything).map{|x| x.is_a?(Hash) ? [x.keys.first, x.values.first] : [x, {}]}.flatten]
+        end
+      end
+
+      def extract_symbolized_json_from(something)
+        JSON without_callbacks(something), symbolize_names: true
+      end
+
+      def without_callbacks(something)
+        callback_pattern = %r[^.+?\((.*?)\)$]
+        something =~ callback_pattern ? something.match(callback_pattern)[1] : something
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module RSpecApi
+  module Matchers
+    class ContentType
+      def initialize(content_type)
+        @content_type = content_type
+      end
+
+      def matches?(response)
+        @headers = response.headers
+        @headers['Content-Type'] == @content_type if @headers.key? 'Content-Type'
+      end
+
+      def failure_message_for_should
+        "expected headers to #{description}, but got #{@headers}"
+      end
+
+      def failure_message_for_should_not
+        "expected headers not to #{description}, but got #{@headers}"
+      end
+
+      def description
+        %Q{include 'Content-Type': '#{@content_type}'}
+      end
+
+      def description_for_run_if
+        %Q{include any specific 'Content-Type'}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require 'json'
+
+module RSpecApi
+  module Matchers
+    class Filter
+      def initialize(value, options = {})
+        @value = value
+        @field = options[:by]
+        @comparing_with = options.fetch :comparing_with, Proc.new{|x,y| x == y}
+      end
+
+      def matches?(response)
+        @desc = " by #{@field}#{@comparing_with}#{@value}"
+        @body = response.body
+        array = extract_json_from @body
+        array.all? do |item| # TODO: Don't always use string
+          @comparing_with.call @value, item[@field.to_s].to_s
+        end
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        "expected body to #{description}, but got #{@body}"
+      end
+
+      def failure_message_for_should_not
+        "expected body not to #{description}, but it was"
+      end
+
+      def description
+        %Q(be filtered#{@desc})
+      end
+
+    private
+
+      # These go elsewhere
+
+      def extract_json_from(something)
+        array = JSON without_callbacks(something)
+        if array.is_a?(Array) and array.empty?
+          raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is sorted, but the array is empty. Try with more fixtures"
+        end
+        array
+      rescue JSON::ParserError, JSON::GeneratorError
+        nil
+      end
+
+      def without_callbacks(something)
+        callback_pattern = %r[^.+?\((.*?)\)$]
+        something =~ callback_pattern ? something.match(callback_pattern)[1] : something
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'json'
+
+module RSpecApi
+  module Matchers
+    class Json
+      def initialize(type)
+        @type = type
+        @desc = " #{@type}" if @type
+      end
+
+      def matches?(response)
+        @body = response.body
+        json = parse_json_of @body
+        @type ? json.is_a?(@type) : true
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        "expected body to #{description}, but got #{@body}"
+      end
+
+      def failure_message_for_should_not
+        "expected body not to #{description}, but it was"
+      end
+
+      def description
+        %Q(be a valid JSON#{@desc})
+      end
+
+    private
+
+      # These go elsewhere
+
+      def parse_json_of(something)
+        JSON without_callbacks(something)
+      rescue JSON::ParserError, JSON::GeneratorError
+        nil
+      end
+
+      def without_callbacks(something)
+        callback_pattern = %r[^.+?\((.*?)\)$]
+        something =~ callback_pattern ? something.match(callback_pattern)[1] : something
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RSpecApi
+  module Matchers
+    class Jsonp
+      def initialize(callback)
+        @callback = callback
+      end
+
+      def matches?(response)
+        @body = response.body
+        @body =~ %r{^#{@callback || '.+?'}\((.*?)\)$}
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        "expected body to #{description}, but got #{@body}"
+      end
+
+      def failure_message_for_should_not
+        "expected body not to #{description}, but it was"
+      end
+
+      def description
+        %Q(be wrapped in a JSONP callback #{@callback}).rstrip
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module RSpecApi
+  module Matchers
+    class PrevPageLink
+      def matches?(response)
+        @headers = response.headers
+        links = @headers['Link'] || '' # not fetch, see http://git.io/CUz3-Q
+        links =~ %r{<.+?>. rel\="prev"}
+      end
+
+      def failure_message_for_should
+        "expected headers to #{description}, but got #{@headers}"
+      end
+
+      def failure_message_for_should_not
+        "expected headers not to #{description}, but got #{@headers}"
+      end
+
+      def description
+        %Q{include a 'Link' to the previous page}
+      end
+
+      def description_for_run_if
+        %Q{include any specific pagination 'Link'}
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+module RSpecApi
+  module Matchers
+    class RunIf
+      def initialize(run, matcher)
+        @run = run
+        @matcher = matcher
+      end
+
+      def matches?(response)
+        !@run || @matcher.matches?(response)
+      end
+      alias == matches?
+
+      def does_not_match?(response)
+        !@run || !matches?(response)
+      end
+
+      def failure_message_for_should
+        @matcher.failure_message_for_should
+      end
+
+      def failure_message_for_should_not
+        @matcher.failure_message_for_should_not
+      end
+
+      def description
+        if @run
+          @matcher.description
+        else
+          if @matcher.respond_to? :description_for_run_if
+            %Q{not be expected to #{@matcher.description_for_run_if}}
+          else
+            %Q{not be expected to #{@matcher.description}}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+require 'json'
+
+module RSpecApi
+  module Matchers
+    class Sort
+      def initialize(options = {})
+        @field = options[:by]
+        @reverse = options[:verse].to_s == 'desc' || options[:verse].to_s == 'descending' || options[:reverse] == true || options[:ascending] == true || options[:asc] == true || options[:descending] == false || options[:desc] == false
+      end
+
+      def matches?(response)
+        # If we don't get which field the body should be sorted by, then we
+        # say that it's sorted. For instance sort by random... no expectations
+        # We might still want to do some check about being a JSON array, though
+        if @field.nil?
+          true
+        else
+          @desc = " by #{'descending ' if @reverse}#{@field}"
+          @body = response.body
+          array = extract_array of: @field, from: @body # what if this fails?
+          is_sorted? array, @reverse
+        end
+      end
+      alias == matches?
+
+      def failure_message_for_should
+        # NOTE: might just print the (unsorted) fields, not the whole @body
+        "expected body to #{description}, but got #{@body}"
+      end
+
+      def failure_message_for_should_not
+        "expected body not to #{description}, but it was"
+      end
+
+      def description
+        %Q(be sorted#{@desc})
+      end
+
+    private
+
+      def is_sorted?(array, reverse)
+        return false unless array.is_a?(Array)
+        array.reverse! if reverse
+        array == array.sort
+      end
+
+      # These go elsewhere
+
+      def extract_array(options = {})
+        array = JSON without_callbacks(options[:from])
+        if array.is_a?(Array) and array.empty?
+          raise RSpec::Core::Pending::PendingDeclaredInExample.new "You are testing if an array is sorted, but the array is empty. Try with more fixtures"
+        end
+        array.map{|item| item[options[:of].to_s]} # what if it's not an array of hashes?
+      rescue JSON::ParserError, JSON::GeneratorError
+        nil
+      end
+
+      def without_callbacks(something)
+        callback_pattern = %r[^.+?\((.*?)\)$]
+        something =~ callback_pattern ? something.match(callback_pattern)[1] : something
+      end
+    end
+  end
+end

data/lib/rspec-api/matchers/{match_status.rb → status.rb}

@@ -2,27 +2,27 @@ require 'rack/utils'
 
 module RSpecApi
   module Matchers
-    class MatchStatus
-      def initialize(expected_status)
-        @expected_status = expected_status
+    class Status
+      def initialize(status)
+        @expected_status = status
       end
 
-      def matches?(actual_code)
-        @actual_code = actual_code
-        actual_code == expected_code
+      def matches?(response)
+        @status = response.status
+        @status == expected_code
       end
       alias == matches?
 
       def failure_message_for_should
-        "expected #{@actual_code} to #{description}"
+        "expected HTTP status code #{expected_code}, got #{@status}"
       end
 
       def failure_message_for_should_not
-        "expected #{@actual_code} not to #{description}"
+        "expected HTTP status code not to be #{expected_code}, but it was"
       end
 
       def description
-        "be #{@expected_status}"
+        "be HTTP status code #{expected_code}"
       end
 
     private
@@ -36,7 +36,7 @@ module RSpecApi
       # @example
       # status_to_code(:ok) # => 200
       # status_to_code(200) # => 200
-      # status_to_code(987) # => raise
+      # status_to_code(987) # => raise ArgumentError
       def status_to_numeric_code(status)
         code = status.is_a?(Symbol) ? Rack::Utils.status_code(status) : status
         validate_status_code! code
@@ -47,7 +47,7 @@ module RSpecApi
       #
       # @example
       # validate_status_code!(200) # => (no error)
-      # validate_status_code!(999) # => raise
+      # validate_status_code!(999) # => raise ArgumentError
       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}"

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-matchers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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
@@ -87,8 +101,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rspec-api/matchers/match_status.rb
-- lib/rspec-api/matchers/matchers.rb
+- lib/rspec-api/dsl/be_a_jsonp.rb
+- lib/rspec-api/dsl/be_filtered.rb
+- lib/rspec-api/dsl/be_sorted.rb
+- lib/rspec-api/dsl/be_valid_json.rb
+- lib/rspec-api/dsl/have_attributes.rb
+- lib/rspec-api/dsl/have_prev_page_link.rb
+- lib/rspec-api/dsl/have_status.rb
+- lib/rspec-api/dsl/include_content_type.rb
+- lib/rspec-api/dsl/run_if.rb
+- lib/rspec-api/matchers/attributes.rb
+- lib/rspec-api/matchers/content_type.rb
+- lib/rspec-api/matchers/filter.rb
+- lib/rspec-api/matchers/json.rb
+- lib/rspec-api/matchers/jsonp.rb
+- lib/rspec-api/matchers/prev_page_link.rb
+- lib/rspec-api/matchers/run_if.rb
+- lib/rspec-api/matchers/sort.rb
+- lib/rspec-api/matchers/status.rb
 - lib/rspec-api/matchers/version.rb
 - lib/rspec-api/matchers.rb
 - lib/rspec-api-matchers.rb

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

@@ -1,26 +0,0 @@
-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