rspec-api-matchers 0.5.0 → 0.6.0

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

@@ -1,24 +0,0 @@
-require 'rspec-api/matchers/collection'
-
-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 a collection
-      #
-      # @example
-      #
-      #   # Passes if the body is a collection
-      #   body = '[{"id": 1}]'
-      #   expect(OpenStruct.new body: body).to be_a_collection
-      #
-      #   # Passes if the body is not a collection
-      #   body = '{"id": 1}'
-      #   expect(OpenStruct.new body: body).not_to be_a_collection
-      def be_a_collection
-        RSpecApi::Matchers::Collection.new
-      end
-    end
-  end
-end

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

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

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

@@ -1,24 +0,0 @@
-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/have_attributes.rb

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

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

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

@@ -1,24 +0,0 @@
-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'
-        when :any then %r{}
-        end
-        RSpecApi::Matchers::ContentType.new(content_type)
-      end
-    end
-  end
-end

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

@@ -1,171 +0,0 @@
-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 has attributes, 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/collection.rb

@@ -1,42 +0,0 @@
-require 'json'
-
-module RSpecApi
-  module Matchers
-    class Collection
-
-      def matches?(response)
-        @body = response.body
-        json = parse_json_of @body
-        json.is_a?(Array)
-      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 got #{@body}"
-      end
-
-      def description
-        %Q(be a collection)
-      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/content_type.rb

@@ -1,26 +0,0 @@
-module RSpecApi
-  module Matchers
-    class ContentType
-      def initialize(content_type)
-        @content_type = content_type
-      end
-
-      def matches?(response)
-        @headers = response.headers
-        @content_type.match @headers['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
-    end
-  end
-end