rspec-api-matchers 0.5.0 → 0.6.0

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

@@ -0,0 +1,28 @@
+require 'rspec-api/matchers/response/matcher'
+
+module RSpecApi
+  module Matchers
+    module Headers
+      class Matcher < Response::Matcher
+
+        def matches?(response)
+          super && headers.is_a?(Hash) && headers.any?
+        end
+
+        def description
+          %Q{be a non-empty Hash}
+        end
+
+      private
+
+        def actual
+          headers
+        end
+
+        def match
+          'headers'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'rspec-api/matchers/json/matcher'
+
+module RSpecApi
+  module Matchers
+    module Json
+      # Passes if response body is a valid JSON or callback-wrapped JSON
+      #
+      # @example
+      #
+      #   # Passes if the body is valid JSON
+      #   body = '[{"id": 1}]'
+      #   expect(OpenStruct.new body: body).to be_valid_json
+      #
+      # For more examples check +be_valid_json_spec.rb+.
+      def be_valid_json
+        RSpecApi::Matchers::Json::Matcher.new
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'rspec-api/matchers/response/matcher'
+require 'json'
+
+module RSpecApi
+  module Matchers
+    module Json
+      class Matcher < Response::Matcher
+
+        def matches?(response)
+          super && json
+        end
+        alias == matches?
+
+        def description
+          %Q(be valid JSON)
+        end
+
+      private
+
+        def actual
+          body
+        end
+
+        def match
+          'body'
+        end
+
+        def json
+          @json ||= JSON strip_callback(body), symbolize_names: true
+        rescue JSON::ParserError, JSON::GeneratorError
+          nil
+        end
+
+        def strip_callback(text)
+          callback_pattern = %r[^.+?\((.*?)\)$]
+          text =~ callback_pattern ? text.match(callback_pattern)[1] : text
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'rspec-api/matchers/jsonp/matcher'
+
+module RSpecApi
+  module Matchers
+    module Jsonp
+      # Passes if response body is a valid JSON wrapped in a JSONP callback
+      #
+      # @example
+      #
+      #   # Passes if the body is wrapped in "alert"
+      #   body = 'alert([{"id": 1}])'
+      #   expect(OpenStruct.new body: body).to be_wrapped_in_callback(:alert)
+      #
+      # @note
+      #
+      # A JSONP should actually return application/javascript...
+      #
+      # For more examples check +be_wrapped_in_callback_spec.rb+.
+      def be_wrapped_in_callback(callback = nil)
+        RSpecApi::Matchers::Jsonp::Matcher.new callback
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+require 'rspec-api/matchers/json/matcher'
+
+module RSpecApi
+  module Matchers
+    module Jsonp
+      class Matcher < Json::Matcher
+        attr_accessor :callback
+
+        def initialize(callback)
+          @callback = callback
+        end
+
+        def matches?(response)
+          super && body =~ %r{^#{callback || '.+?'}\((.*?)\)$}
+        end
+
+        def description
+          %Q(be wrapped in a JSONP callback #{callback}).rstrip
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'rspec-api/matchers/page_links/matcher'
+
+module RSpecApi
+  module Matchers
+    module PageLinks
+      # Passes if response headers include pagination links ()
+      #
+      # @example
+      #
+      #   # Passes if the headers include a link to the previous page
+      #   headers = {'Link' => '<https://example.com/1>; rel="prev"'}
+      #   expect(OpenStruct.new headers: headers).to have_page_links
+      #
+      # @note
+      #
+      # Checking for the rel="prev" is probably enough for the purpose.
+      # See http://tools.ietf.org/html/rfc5988#page-6 for Link specification.
+      #
+      # For more examples check +have_page_links_spec.rb+.
+      def have_page_links
+        RSpecApi::Matchers::PageLinks::Matcher.new
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'rspec-api/matchers/headers/matcher'
+
+module RSpecApi
+  module Matchers
+    module PageLinks
+      class Matcher < Headers::Matcher
+        def matches?(response)
+          # NOTE: Only use headers.fetch('Link', '') after http://git.io/CUz3-Q
+          super && (headers['Link'] || '') =~ %r{<.+?>. rel\="prev"}
+        end
+
+        def description
+          %Q{include a 'Link' to the previous page}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'rspec-api/matchers/response/matcher'
+
+module RSpecApi
+  module Matchers
+    module Response
+      # Passes if response is present
+      #
+      # @example
+      #
+      #   # Passes if the response has a status
+      #   response = OpenStruct.new status: 100
+      #   expect(response).to be_a_valid_response
+      #
+      # For more examples check +be_a_valid_response_spec.rb+.
+      def be_a_valid_response
+        RSpecApi::Matchers::Response::Matcher.new
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+require 'ostruct'
+require 'json'
+
+module RSpecApi
+  module Matchers
+    module Response
+      class Matcher
+        attr_accessor :response
+
+        def matches?(response)
+          @response = response || OpenStruct.new
+          status || headers || body
+        end
+        alias == matches?
+
+        def description
+          %Q(be a valid response)
+        end
+
+        def failure_message_for_should
+          "expected #{match} to #{description}, but got #{actual}"
+        end
+
+        def failure_message_for_should_not
+          "expected #{match} not to #{description}, but got #{actual}"
+        end
+
+      private
+
+        def body
+          @body ||= response.body
+        end
+
+        def headers
+          @headers ||= response.headers
+        end
+
+        def status
+          @status ||= response.status
+        end
+
+        def match
+          'response'
+        end
+
+        def actual
+          response
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require 'rspec-api/matchers/sort/matcher'
+
+module RSpecApi
+  module Matchers
+    module Sort
+      # Passes if the response body is a non-empty sorted JSON collection
+      #
+      # @example
+      #
+      #   # Passes if the body is sorted by descending IDs
+      #   body = '[{"id": 3}, {"id": 2}, {"id": 1}]'
+      #   expect(OpenStruct.new body: body).to be_sorted(by: :id, verse: :desc)
+      #
+      # For more examples check +be_sorted_spec.rb+.
+      def be_sorted(options = {})
+        RSpecApi::Matchers::Sort::Matcher.new options
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+require 'rspec-api/matchers/collection/matcher'
+
+module RSpecApi
+  module Matchers
+    module Sort
+      class Matcher < Collection::Matcher
+        attr_accessor :field, :verse
+
+        def initialize(options = {})
+          @field = options[:by]
+          @verse = options[:verse]
+        end
+
+        def matches?(response)
+          super && all_objects_have_field? && has_two_objects? && is_sorted?
+        end
+
+        def description
+          if field
+            %Q(be sorted by #{reverse? ? 'descending' : 'ascending'} #{field})
+          else
+            %Q(be sorted)
+          end
+        end
+
+      private
+
+        def all_objects_have_field?
+          if field
+            json.all?{|item| item.is_a?(Hash) && item.key?(field)}
+          else
+            true
+          end
+        end
+
+        def has_two_objects?
+          if json.length < 2
+            msg = "Cannot test sorting on an array with #{json.length} items"
+            raise RSpec::Core::Pending::PendingDeclaredInExample.new msg
+          else
+            true
+          end
+        end
+
+        def is_sorted?
+          values = json.map{|item| item[field]}
+          values.sort == (reverse? ? values.reverse : values)
+        end
+
+        def reverse?
+          ['desc', 'descending'].include? verse.to_s
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+require 'rspec-api/matchers/status/matcher'
+
+module RSpecApi
+  module Matchers
+    module Status
+      # Passes if the response has a status that matches +status+.
+      #
+      # @example
+      #
+      #   # Passes if the response status matches :ok
+      #   status = :ok
+      #   expect(OpenStruct.new status: status).to have_status 200
+      #
+      # @note
+      #
+      #   The full list of symbolic HTTP status codes is available at:
+      #   http://git.io/YwpDnA#L542
+      #
+      # For more examples check +have_headers_spec.rb+.
+      def have_status(status)
+        RSpecApi::Matchers::Status::Matcher.new status
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+require 'rack/utils'
+require 'rspec-api/matchers/response/matcher'
+
+module RSpecApi
+  module Matchers
+    module Status
+      class Matcher < Response::Matcher
+        attr_accessor :status_symbol_or_code
+
+        def initialize(status_symbol_or_code)
+          @status_symbol_or_code = status_symbol_or_code
+        end
+
+        def matches?(response)
+          super && status == status_code
+        end
+
+        def description
+          "be #{status_code}"
+        end
+
+      private
+
+        def status_code
+          to_code status_symbol_or_code
+        end
+
+        def to_code(symbol_or_code)
+          if symbol_or_code.is_a? Symbol
+            Rack::Utils.status_code symbol_or_code
+          else
+            symbol_or_code
+          end
+        end
+
+        def actual
+          status
+        end
+
+        def match
+          'status code'
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module RSpecApi
   module Matchers
-    VERSION = '0.5.0'
+    VERSION = '0.6.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-api-matchers
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - claudiob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -101,22 +101,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rspec-api/dsl/be_a_collection.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/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/matchers/attributes.rb
-- lib/rspec-api/matchers/collection.rb
-- lib/rspec-api/matchers/content_type.rb
-- lib/rspec-api/matchers/filter.rb
-- lib/rspec-api/matchers/jsonp.rb
-- lib/rspec-api/matchers/prev_page_link.rb
-- lib/rspec-api/matchers/sort.rb
-- lib/rspec-api/matchers/status.rb
+- lib/rspec-api/matchers/attributes/have_attributes.rb
+- lib/rspec-api/matchers/attributes/matcher.rb
+- lib/rspec-api/matchers/collection/be_a_collection.rb
+- lib/rspec-api/matchers/collection/matcher.rb
+- lib/rspec-api/matchers/content_type/have_content_type.rb
+- lib/rspec-api/matchers/content_type/matcher.rb
+- lib/rspec-api/matchers/filter/be_filtered.rb
+- lib/rspec-api/matchers/filter/matcher.rb
+- lib/rspec-api/matchers/headers/have_headers.rb
+- lib/rspec-api/matchers/headers/matcher.rb
+- lib/rspec-api/matchers/json/be_valid_json.rb
+- lib/rspec-api/matchers/json/matcher.rb
+- lib/rspec-api/matchers/jsonp/be_wrapped_in_callback.rb
+- lib/rspec-api/matchers/jsonp/matcher.rb
+- lib/rspec-api/matchers/page_links/have_page_links.rb
+- lib/rspec-api/matchers/page_links/matcher.rb
+- lib/rspec-api/matchers/response/be_a_valid_response.rb
+- lib/rspec-api/matchers/response/matcher.rb
+- lib/rspec-api/matchers/sort/be_sorted.rb
+- lib/rspec-api/matchers/sort/matcher.rb
+- lib/rspec-api/matchers/status/have_status.rb
+- lib/rspec-api/matchers/status/matcher.rb
 - lib/rspec-api/matchers/version.rb
 - lib/rspec-api/matchers.rb
 - lib/rspec-api-matchers.rb