api_matchers 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55a5fba1fb8dd8e0534a451e2db5af8662312b0e
-  data.tar.gz: dfe3690699a99aeffe353d50c7401a5eb741e084
+  metadata.gz: e256da4250d9b304bed9733e30b1949b13f60c27
+  data.tar.gz: 361d34707eafd42661b8dea22bdaa95470eb8632
 SHA512:
-  metadata.gz: 8a28c82e8bfeede2915149c45e89f0698c9c1600dfeaefb4ddda8e06ad0e88649144a59dd0f40cbe4f2b6b2465b5ea5ca0b205d41bcf8110a416354691d12582
-  data.tar.gz: 0d594066a2ba47024bb9cd1126578e0cef31f81a6b97ad009d8f7161f7290384a7a641127b35639b02043662f8b56f44acfeba49c14ed73f75999a6db521c443
+  metadata.gz: 35c9a63f902431792e244e97a8b6f11307b7b4afc5cb8250a960b43039b3e2aadce22321347c3cf00536169f5074449dfeadccc994ee72275935a26ffd5c206e
+  data.tar.gz: 803747cf15d4d5d461a5ad23d84541a6ede2a878a08e34e5e0808967c35136fb25493b80aaf98bb219fa851c91ce4368ef42c735b872a9ebdb9f7145f6a129bb

data/.rspec

@@ -0,0 +1 @@
+--color

data/History.markdown

@@ -1,3 +1,12 @@
+## development
+
+* Internals - Migrate to the RSpec expect syntax.
+
+## v0.4.0
+
+* jRuby support;
+* have_json matcher;
+
 ## v0.1.1
 
 1) Support Datetime, Date and Time comparison (Thanks to Stephen Orens).

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Tomas D'Stefano
+Copyright (c) 2012-2013 Tomas D'Stefano
 
 MIT License
 

data/README.markdown

@@ -129,7 +129,9 @@ end
 response.should have_node(:foo).with('bar')
 ```
 
-# Instead of:
+Instead of:
+
+```ruby
 response.body.should have_node(:foo)
 ```
 

data/TODO.markdown

@@ -1,2 +1,3 @@
 * Refactor Core::FindInJSON#find method.
-* Adding some include matcher about node arrays.
+* Improve the error messages from all matchers.
+* Adding some include matcher about node arrays.

data/api_matchers.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = APIMatchers::VERSION
 
-  gem.add_dependency 'rspec', '>= 2.10.0'
+  gem.add_dependency 'rspec', '>= 2.14'
   gem.add_dependency 'activesupport', '>= 3.2.5'
   gem.add_dependency 'nokogiri', '>= 1.5.2'
 end

data/lib/api_matchers.rb

@@ -14,6 +14,7 @@ module APIMatchers
     autoload :BeInternalServerError, 'api_matchers/http_status_code/be_internal_server_error'
     autoload :BeUnauthorized, 'api_matchers/http_status_code/be_unauthorized'
     autoload :BeOk, 'api_matchers/http_status_code/be_ok'
+    autoload :BeUnprocessableEntity, 'api_matchers/http_status_code/be_unprocessable_entity'
     autoload :CreateResource, 'api_matchers/http_status_code/create_resource'
   end
 

data/lib/api_matchers/core/rspec_matchers.rb

@@ -22,6 +22,10 @@ module APIMatchers
       ::APIMatchers::HTTPStatusCode::BeOk.new(::APIMatchers::Core::Setup)
     end
 
+    def be_unprocessable_entity
+      ::APIMatchers::HTTPStatusCode::BeUnprocessableEntity.new(::APIMatchers::Core::Setup)
+    end
+
     def create_resource
       ::APIMatchers::HTTPStatusCode::CreateResource.new(::APIMatchers::Core::Setup)
     end

data/lib/api_matchers/headers/base.rb

@@ -29,4 +29,4 @@ module APIMatchers
       end
     end
   end
-end
+end

data/lib/api_matchers/headers/be_json.rb

@@ -5,13 +5,17 @@ module APIMatchers
         'application/json; charset=utf-8'
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected a JSON response with '#{expected_content_type}'. Got: '#{content_type_response}'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected to not be a JSON response. Got: '#{expected_content_type}'.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/headers/be_xml.rb

@@ -5,13 +5,17 @@ module APIMatchers
         'application/xml; charset=utf-8'
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected a XML response with '#{expected_content_type}'. Got: '#{content_type_response}'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected to not be a XML response. Got: '#{expected_content_type}'.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/http_status_code/base.rb

@@ -29,4 +29,4 @@ module APIMatchers
       end
     end
   end
-end
+end

data/lib/api_matchers/http_status_code/be_bad_request.rb

@@ -5,13 +5,17 @@ module APIMatchers
         400
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected that '#{@http_status_code}' to be a Bad Request with the status '400'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected that '#{@http_status_code}' to NOT be a Bad Request with the status '400'.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/http_status_code/be_internal_server_error.rb

@@ -5,13 +5,17 @@ module APIMatchers
         500
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected that '#{@http_status_code}' to be Internal Server Error with the status '500'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected that '#{@http_status_code}' to NOT be Internal Server Error.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/http_status_code/be_not_found.rb

@@ -5,13 +5,17 @@ module APIMatchers
         404
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected that '#{@http_status_code}' to be Not Found with the status '404'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected that '#{@http_status_code}' to NOT be Not Found with the status '404'.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/http_status_code/be_ok.rb

@@ -5,13 +5,17 @@ module APIMatchers
         200
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected that '#{@http_status_code}' to be ok with the status '200'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected that '#{@http_status_code}' to NOT be ok with the status '200'.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/http_status_code/be_unauthorized.rb

@@ -5,13 +5,17 @@ module APIMatchers
         401
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected that '#{@http_status_code}' to be Unauthorized with the status '401'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected that '#{@http_status_code}' to NOT be Unauthorized.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/http_status_code/be_unprocessable_entity.rb

@@ -0,0 +1,21 @@
+module APIMatchers
+  module HTTPStatusCode
+    class BeUnprocessableEntity < Base
+      def expected_status_code
+        422
+      end
+
+      def failure_message
+        %Q{expected that '#{@http_status_code}' to be Unprocessable entity with the status '#{expected_status_code}'.}
+      end
+
+      def failure_message_when_negated
+        %Q{expected that '#{@http_status_code}' to NOT be Unprocessable entity with the status '#{expected_status_code}'.}
+      end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
+    end
+  end
+end

data/lib/api_matchers/http_status_code/create_resource.rb

@@ -5,13 +5,17 @@ module APIMatchers
         201
       end
 
-      def failure_message_for_should
+      def failure_message
         %Q{expected that '#{@http_status_code}' to be Created Resource with the status '201'.}
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         %Q{expected that '#{@http_status_code}' to NOT be Created Resource.}
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
-end
+end

data/lib/api_matchers/response_body/base.rb

@@ -31,14 +31,18 @@ module APIMatchers
         end
       end
 
-      def failure_message_for_should
+      def failure_message
         "expected to have node called: '#{@expected_node}'" << added_message << ". Got: '#{response_body}'"
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         "expected to NOT have node called: '#{@expected_node}'" << added_message << ". Got: '#{response_body}'"
       end
 
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
+
       def added_message
         if @with_value
           " with value: '#{@with_value}'"

data/lib/api_matchers/response_body/have_json.rb

@@ -14,14 +14,17 @@ module APIMatchers
         @expected_json == json
       end
 
-      def failure_message_for_should
+      def failure_message
         "expect to have json: '#{response_body}'. Got: '#{json}'."
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         "expect to NOT have json: '#{response_body}'."
       end
+
+      # RSpec 2 compatibility:
+      alias_method :failure_message_for_should, :failure_message
+      alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
   end
 end
-

data/lib/api_matchers/version.rb

@@ -1,3 +1,3 @@
 module APIMatchers
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/api_matchers/core/find_in_json_spec.rb

@@ -5,21 +5,21 @@ module APIMatchers::Core
     describe "#find" do
       context 'when node exists' do
         it "should return the value of the expected key" do
-          FindInJSON.new('product' => 'gateway').find(node: 'product').should eql 'gateway'
+          expect(FindInJSON.new('product' => 'gateway').find(node: 'product')).to eql 'gateway'
         end
 
         it "should return the value of the deep expected key in the json" do
-          FindInJSON.new('transaction' => { 'error' => { 'code' => '999' } }).find(node: 'code').should eql '999'
+          expect(FindInJSON.new('transaction' => { 'error' => { 'code' => '999' } }).find(node: 'code')).to eql '999'
         end
       end
 
       context 'when node do not exists' do
         it "should return nil if don't find the expected node" do
-          expect{ FindInJSON.new('product' => 'pabx').find(node: 'developers').should raise_error( ::APIMatchers::Core::Exceptions::KeyNotFound ) }
+          expect { FindInJSON.new('product' => 'pabx').find(node: 'developers') }.to raise_error( ::APIMatchers::Core::Exceptions::KeyNotFound)
         end
 
         it "should return nil if don't find the expected node in the deep JSON" do
-          expect{ FindInJSON.new('transaction' => { 'id' => 150, 'error' => {} }).find(node: 'code').should raise_error( ::APIMatchers::Core::Exceptions::KeyNotFound ) }
+          expect { FindInJSON.new('transaction' => { 'id' => 150, 'error' => {} }).find(node: 'code') }.to raise_error( ::APIMatchers::Core::Exceptions::KeyNotFound)
         end
       end
     end

data/spec/api_matchers/headers/be_json_spec.rb

@@ -1,23 +1,27 @@
 require 'spec_helper'
 
 describe APIMatchers::Headers::BeJSON do
-  describe "actual.should be_json" do
+  describe "actual.to be_json" do
     it "should pass when the actual is json response" do
-      "application/json; charset=utf-8".should be_json
+      expect("application/json; charset=utf-8").to be_json
     end
 
     it "should not pass when the actual is not a json response" do
-      expect { "application/xml; charset=utf-8".should be_json }.to fail_with(%Q{expected a JSON response with 'application/json; charset=utf-8'. Got: 'application/xml; charset=utf-8'.})
+      expect {
+        expect("application/xml; charset=utf-8").to be_json
+      }.to fail_with(%Q{expected a JSON response with 'application/json; charset=utf-8'. Got: 'application/xml; charset=utf-8'.})
     end
   end
 
-  describe "actual.should_not be_json" do
+  describe "actual.not_to be_json" do
     it "should pass when the actual is not a json response" do
-      "application/xml; charset=utf-8".should_not be_json
+      expect("application/xml; charset=utf-8").not_to be_json
     end
 
     it "should not pass when the actual is a json response" do
-      expect { "application/json; charset=utf-8".should_not be_json }.to fail_with(%Q{expected to not be a JSON response. Got: 'application/json; charset=utf-8'.})
+      expect{
+        expect("application/json; charset=utf-8").not_to be_json
+      }.to fail_with(%Q{expected to not be a JSON response. Got: 'application/json; charset=utf-8'.})
     end
   end
 
@@ -38,17 +42,21 @@ describe APIMatchers::Headers::BeJSON do
 
     it "should pass if the actual.response_header is equal to application/json" do
       response = OpenStruct.new(:response_header => { 'Content-Type' => "application/json; charset=utf-8"})
-      response.should be_json
+      expect(response).to be_json
     end
 
     it "should fail if the actual.response_header is not equal to application/json" do
       response = OpenStruct.new(:response_header => { "Content-Type" => "application/xml; charset=utf-8"})
-      expect { response.should be_json }.to fail_with(%Q{expected a JSON response with 'application/json; charset=utf-8'. Got: 'application/xml; charset=utf-8'.})
+      expect {
+        expect(response).to be_json
+      }.to fail_with(%Q{expected a JSON response with 'application/json; charset=utf-8'. Got: 'application/xml; charset=utf-8'.})
     end
 
     it "should fail if the actual.response_header is not equal to application/json" do
       response = OpenStruct.new(:response_header => { "foo-bar" => "application/xml; charset=utf-8"})
-      expect { response.should be_json }.to fail_with(%Q{expected a JSON response with 'application/json; charset=utf-8'. Got: '{"foo-bar"=>"application/xml; charset=utf-8"}'.})
+      expect {
+        expect(response).to be_json
+      }.to fail_with(%Q{expected a JSON response with 'application/json; charset=utf-8'. Got: '{"foo-bar"=>"application/xml; charset=utf-8"}'.})
     end
   end
 end

data/spec/api_matchers/headers/be_xml_spec.rb

@@ -1,26 +1,26 @@
 require 'spec_helper'
 
 describe APIMatchers::Headers::BeXML do
-  describe "actual.should be_xml" do
+  describe "actual.to be_xml" do
     it "should pass when the actual is json response" do
-      "application/xml; charset=utf-8".should be_xml
+      expect("application/xml; charset=utf-8").to be_xml
     end
 
     it "should not pass when the actual is not a json response" do
       expect {
-        "application/json; charset=utf-8".should be_xml
+        expect("application/json; charset=utf-8").to be_xml
       }.to fail_with(%Q{expected a XML response with 'application/xml; charset=utf-8'. Got: 'application/json; charset=utf-8'.})
     end
   end
 
-  describe "actual.should_not be_xml" do
+  describe "actual.not_to be_xml" do
     it "should pass when the actual is not a json response" do
-      "application/json; charset=utf-8".should_not be_xml
+      expect("application/json; charset=utf-8").not_to be_xml
     end
 
     it "should not pass when the actual is a json response" do
       expect {
-        "application/xml; charset=utf-8".should_not be_xml
+        expect("application/xml; charset=utf-8").not_to be_xml
       }.to fail_with(%Q{expected to not be a XML response. Got: 'application/xml; charset=utf-8'.})
     end
   end
@@ -42,17 +42,21 @@ describe APIMatchers::Headers::BeXML do
 
     it "should pass if the actual.response_header is equal to application/xml" do
       response = OpenStruct.new(:response_header => { 'Content-Type' => "application/xml; charset=utf-8"})
-      response.should be_xml
+      expect(response).to be_xml
     end
 
     it "should fail if the actual.response_header is not equal to application/xml" do
       response = OpenStruct.new(:response_header => { "Content-Type" => "application/json; charset=utf-8"})
-      expect { response.should be_xml }.to fail_with(%Q{expected a XML response with 'application/xml; charset=utf-8'. Got: 'application/json; charset=utf-8'.})
+      expect {
+        expect(response).to be_xml
+      }.to fail_with(%Q{expected a XML response with 'application/xml; charset=utf-8'. Got: 'application/json; charset=utf-8'.})
     end
 
     it "should fail when pass the actual that have headers but not the content type key" do
       response = OpenStruct.new(:response_header => { "foo-baz" => "application/json; charset=utf-8"})
-      expect { response.should be_xml }.to fail_with(%Q{expected a XML response with 'application/xml; charset=utf-8'. Got: '{"foo-baz"=>"application/json; charset=utf-8"}'.})
+      expect {
+        expect(response).to be_xml
+      }.to fail_with(%Q{expected a XML response with 'application/xml; charset=utf-8'. Got: '{"foo-baz"=>"application/json; charset=utf-8"}'.})
     end
   end
 end