api_matchers 0.0.1 → 0.0.2

data/History.markdown

@@ -1,4 +1,25 @@
-## development
+## v0.0.2
+
+1) Put the headers method and the content type key in the setup class and that will be used by the headers matchers(be_json and be_xml).
+
+This:
+
+    response.headers['Content-Type'].should be_in_json
+    response.headers['Content-Type'].should be_in_xml
+
+With:
+
+    APIMatchers.setup do |config|
+      config.header_method           = :headers
+      config.header_content_type_key = 'Content-Type'
+    end
+
+Becomes:
+
+    response.should be_in_json
+    response.should be_in_xml
+
+## v0.0.1
 
 1) Headers Matchers: be_xml, be_json (**OBS:** Need to think about the setup!)
 2) HTTP Status Matchers: be_a_bad_request, be_internal_server_error, be_unauthorized, create_resource

data/README.markdown

@@ -22,27 +22,28 @@ Collection of RSpec matchers for create your API.
 
 ## Usage
 
-### Have Node Matcher
+### Including in RSpec
 
-      "{ 'transaction': { 'id': '54', 'status': 'paid' } }".should have_node(:transaction)
+To include all this matchers you need to include the APIMatchers::RSpecMatchers module:
 
-      "{ 'transaction': { 'id': '54', 'status': 'paid' } }".should have_node(:id).with(54)
+    RSpec.configure do |config|
+      config.include APIMatchers::RSpecMatchers
+    end
 
-      "{ 'error': '', 'transaction': { 'id': '55', 'status': 'waiting_payment' } }".should have_node(:error).with('not_authorized')
+### Have Node Matcher
 
-If you want to configure to make all **searches inside a root element**, you can do this:
+The have_node matcher parse the actual and see if have the expcted node with the expected value.
+**The default that have_node will parse is JSON.**
 
-      APIMatchers.setup do |config|
-        config.root_element = :transaction
-      end
+      "{ 'transaction': { 'id': '54', 'status': 'paid' } }".should have_node(:transaction)
 
-      "{ 'transaction': { 'id': '54', 'status': 'paid' } }".should have_node(:id).with(54) # WILL PASS
+      "{ 'transaction': { 'id': '54', 'status': 'paid' } }".should have_node(:id).with(54)
 
-      "{ 'error': '', 'transaction': { 'id': '55', 'status': 'waiting_payment' } }".should have_node(:error).with('not_authorized') # WILL NOT PASS BECAUSE THE ERROR NODE ISN'T INSIDE THE TRANSACTION NODE
+      "{ 'error': 'not_authorized', 'transaction': { 'id': '55' } }".should have_node(:error).with('not_authorized')
 
 ### HAVE NODE Matcher Configuration
 
-You can configure if you want xml or json(**JSON is the default**):
+You can configure if you want xml(**JSON is the default**):
 
       APIMatchers.setup do |config|
         config.content_type = :xml
@@ -50,7 +51,7 @@ You can configure if you want xml or json(**JSON is the default**):
 
       '<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status).with('paid')
 
-**Observation: You can use the *have_xml_node* or *have_json_node* if you don't want to configure everytime.**
+**If you work with xml and json in the same API, I recommend that you check the have_json_node and have_xml_node matchers.**
 
 You can configure the name of the method for example:
 
@@ -66,6 +67,15 @@ Then you can use without call the **#body** method:
 
       response.should have_node(:foo).with('bar')
 
+### Have JSON Node Matcher
+
+    "{ 'transaction': { 'id': '54', 'status': 'paid' } }".should have_json_node(:id).with(54)
+
+### Have XML Node Matcher
+
+    "<product><name>gateway</name></product>".should have_xml_node(:name).with('gateway')
+
+
 ### Create Resource Matcher
 
 This matchers see the HTTP STATUS CODE is equal to 201.
@@ -116,13 +126,27 @@ This configurations affects this matchers:
 
 This is a matcher that see if the content type is xml:
 
-    response.content_type.should be_in_xml
+    response.headers['Content-Type'].should be_in_xml
 
 ### Be in JSON Matcher
 
 This is a matcher that see if the content type is in JSON:
 
-    response.content_type.should be_in_json
+    response.headers['Content-Type'].should be_in_json
+
+### Headers Configuration
+
+You can configure the name method to call the headers and content type:
+
+    APIMatchers.setup do |config|
+      config.header_method           = :headers
+      config.header_content_type_key = 'Content-Type'
+    end
+
+Then you can use without call the **#headers** calling the **#['Content-Type']** method:
+
+    response.should be_in_json
+    response.should be_in_xml
 
 ### Acknowlegments
 

data/lib/api_matchers/core/setup.rb

@@ -53,6 +53,28 @@ module APIMatchers
       #
       cattr_accessor :have_node_matcher
       self.have_node_matcher = :json
+
+      # The headers method and the content type key that will be used by the headers matchers.
+      #
+      # ==== Examples
+      #
+      #  response.response_header['Content-Type'].should be_json
+      #  response.response_header['Content-Type'].should be_xml
+      #
+      #  # Instead calling #response_header everytime, you can configure:
+      #
+      #  APIMatchers.setup do |config|
+      #    config.header_method = :response_header
+      #    config.header_content_type_key = 'Content-Type'
+      #  end
+      #
+      # Then:
+      #
+      #  response.should be_json
+      #  response.should be_xml
+      #
+      cattr_accessor :header_method
+      cattr_accessor :header_content_type_key
     end
   end
 end

data/lib/api_matchers/headers/base.rb

@@ -1,9 +1,27 @@
 module APIMatchers
   module Headers
     class Base
+      attr_reader :setup
+
+      def initialize(setup)
+        @setup = setup
+      end
+
       def matches?(actual)
         @actual = actual
-        actual.eql?(expected_content_type)
+
+        content_type_response.eql?(expected_content_type)
+      end
+
+      def content_type_response
+        if @setup.header_method.present? and @setup.header_content_type_key.present?
+          headers = @actual.send(@setup.header_method)
+          if headers.present?
+            headers[@setup.header_content_type_key] || headers
+          end
+        else
+          @actual
+        end
       end
 
       def expected_content_type

data/lib/api_matchers/headers/be_json.rb

@@ -6,7 +6,7 @@ module APIMatchers
       end
 
       def failure_message_for_should
-        %Q{expected a JSON response with '#{expected_content_type}'. Got: '#{@actual}'.}
+        %Q{expected a JSON response with '#{expected_content_type}'. Got: '#{content_type_response}'.}
       end
 
       def failure_message_for_should_not

data/lib/api_matchers/headers/be_xml.rb

@@ -6,7 +6,7 @@ module APIMatchers
       end
 
       def failure_message_for_should
-        %Q{expected a XML response with '#{expected_content_type}'. Got: '#{@actual}'.}
+        %Q{expected a XML response with '#{expected_content_type}'. Got: '#{content_type_response}'.}
       end
 
       def failure_message_for_should_not

data/lib/api_matchers/version.rb

@@ -1,3 +1,3 @@
 module APIMatchers
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/api_matchers/headers/be_json_spec.rb

@@ -20,4 +20,35 @@ describe APIMatchers::Headers::BeJSON 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'.})
     end
   end
+
+  describe "with change configuration" do
+    before do
+      APIMatchers.setup do |config|
+        config.header_method = :response_header
+        config.header_content_type_key = 'Content-Type'
+      end
+    end
+
+    after do
+      APIMatchers.setup do |config|
+        config.header_method = nil
+        config.header_content_type_key = nil
+      end
+    end
+
+    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
+    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'.})
+    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"}'.})
+    end
+  end
 end

data/spec/api_matchers/headers/be_xml_spec.rb

@@ -24,4 +24,35 @@ describe APIMatchers::Headers::BeXML do
       }.to fail_with(%Q{expected to not be a XML response. Got: 'application/xml; charset=utf-8'.})
     end
   end
+
+  describe "with change configuration" do
+    before do
+      APIMatchers.setup do |config|
+        config.header_method = :response_header
+        config.header_content_type_key = 'Content-Type'
+      end
+    end
+
+    after do
+      APIMatchers.setup do |config|
+        config.header_method = nil
+        config.header_content_type_key = nil
+      end
+    end
+
+    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
+    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'.})
+    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"}'.})
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_matchers
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000Z
+date: 2012-07-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153725680 !ruby/object:Gem::Requirement
+  requirement: &2156860320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.11.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153725680
+  version_requirements: *2156860320
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153725180 !ruby/object:Gem::Requirement
+  requirement: &2156859820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.6
   type: :runtime
   prerelease: false
-  version_requirements: *2153725180
+  version_requirements: *2156859820
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2153724720 !ruby/object:Gem::Requirement
+  requirement: &2156859360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 1.5.5
   type: :runtime
   prerelease: false
-  version_requirements: *2153724720
+  version_requirements: *2156859360
 description: Collection of RSpec matchers for create your API.
 email:
 - tomas_stefano@successoft.com