api_matchers 0.3.0 → 0.4.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YTM2MmZhOGZkNjQ4N2Q1M2ZjMTU0ODhmZjE1ZDBiMjljZTE1YTk4NA==
-  data.tar.gz: !binary |-
-    ZGQzMDNiNTQ2YmI2YmU1YWQzZjlkZmZmODk2OTVkZGFmODE1NDc0MA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    Y2RhNTE5NzdmYTkwMjE0ZTVlM2EwZmM0ZjY2Y2U3MWQ2ZjA5OWIwMjY2NGVh
-    MmMzNGZhYmE0MzA0OGQ2NjQxYTgyNTJkMDI4YjhmNDJhZmM0NGNmMjAxZjQw
-    ZTRjM2NlNjI4ZDc5ZjYwZTM2ZTY0ZWIwYTQ1MzRiNmNlOGQ2ZDg=
-  data.tar.gz: !binary |-
-    MzIyNmE0NmIwOGQxODRhMmJkN2ZmNmZkMTllOTFjMGJjMzc1MjQ3ZGY4MWZl
-    NWJjMGFiNjA3ZGRmYjZhMzBkOTAxNzgxM2JkOWQyNzUxNmI5NGRkYWRlMDA1
-    NTI4MWEzNDY1MGY0YzI2NzYzMGYxYzEwZDAwNDQyZGUyZTg3NjQ=
+SHA1:
+  metadata.gz: 55a5fba1fb8dd8e0534a451e2db5af8662312b0e
+  data.tar.gz: dfe3690699a99aeffe353d50c7401a5eb741e084
+SHA512:
+  metadata.gz: 8a28c82e8bfeede2915149c45e89f0698c9c1600dfeaefb4ddda8e06ad0e88649144a59dd0f40cbe4f2b6b2465b5ea5ca0b205d41bcf8110a416354691d12582
+  data.tar.gz: 0d594066a2ba47024bb9cd1126578e0cef31f81a6b97ad009d8f7161f7290384a7a641127b35639b02043662f8b56f44acfeba49c14ed73f75999a6db521c443

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - jruby
+before_install:
+  - export DISPLAY=:99.0
+  - sh -e /etc/init.d/xvfb start
+script:
+  - bundle exec rspec

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in api_matchers.gemspec
 gemspec

data/README.markdown

@@ -1,30 +1,40 @@
-# API Matchers
+# API Matchers [![Build Status](https://travis-ci.org/tomas-stefano/api_matchers.png?branch=master)](https://travis-ci.org/tomas-stefano/api_matchers)
 
-Collection of RSpec matchers for create your API.
+Collection of RSpec matchers for your API.
 
 ## Response Body Matchers
 
-* have_node
-* have_json_node
-* have_xml_node
+* `have_node`
+* `have_json_node`
+* `have_xml_node`
+* `have_json`
 
-# Response Status Matchers
+## Response Status Matchers
 
-* be_ok_
-* create_resource
-* be_a_bad_request
-* be_unauthorized
-* be_internal_server_error
-* be_not_found
+* `be_ok`
+* `create_resource`
+* `be_a_bad_request`
+* `be_unauthorized`
+* `be_internal_server_error`
+* `be_not_found`
 
-# Other Matcher
+## Other Matchers
 
-* be_in_xml
-* be_a_json
+* `be_in_xml`
+* `be_in_json`
 
 ## Install
 
-      gem install api_matchers
+Include the gem to your test group in you Gemfile:
+
+```ruby
+group :test do
+  gem 'api_matchers'
+  # other gems
+end
+```
+
+Or install it manually: `gem install api_matchers`.
 
 ## Usage
 
@@ -33,9 +43,9 @@ Collection of RSpec matchers for create your API.
 To include all this matchers you need to include the APIMatchers::RSpecMatchers module:
 
 ```ruby
-    RSpec.configure do |config|
-      config.include APIMatchers::RSpecMatchers
-    end
+RSpec.configure do |config|
+  config.include APIMatchers::RSpecMatchers
+end
 ```
 
 ### Have Node Matcher
@@ -46,33 +56,33 @@ The have_node matcher parse the actual and see if have the expcted node with the
 You can verify if node exists:
 
 ```ruby
-      '{ "transaction": { "id": 54, "status": "paid" } }'.should have_node(:transaction)
+'{ "transaction": { "id": 54, "status": "paid" } }'.should have_node(:transaction)
 ```
 
 Or if node exist with a value:
 
 ```ruby
-    '{ "transaction": { "id": 54, "status": "paid" } }'.should have_node(:id).with(54)
+'{ "transaction": { "id": 54, "status": "paid" } }'.should have_node(:id).with(54)
 ```
 
 ```ruby
-    '{ "error": "not_authorized" }'.should have_node(:error).with('not_authorized')
+'{ "error": "not_authorized" }'.should have_node(:error).with('not_authorized')
 ```
 
 ```ruby
-   '{"parcels":1 }'.should have_node(:parcels).with(1)
+'{"parcels":1 }'.should have_node(:parcels).with(1)
 ```
 
 To see the json node and see if include a text, you can do this:
 
 ```ruby
-    '{"error": "Transaction error: Name cant be blank"}'.should have_node(:error).including_text("Transaction error")
+'{"error": "Transaction error: Name cant be blank"}'.should have_node(:error).including_text("Transaction error")
 ```
 
 You can verify boolean values too:
 
 ```ruby
-   '{"creditcard":true}'.should have_node(:creditcard).with(true)
+'{"creditcard":true}'.should have_node(:creditcard).with(true)
 ```
 
 ### HAVE NODE Matcher Configuration
@@ -80,65 +90,67 @@ You can verify boolean values too:
 You can configure if you want xml (JSON is the default):
 
 ```ruby
-      APIMatchers.setup do |config|
-        config.content_type = :xml
-      end
+APIMatchers.setup do |config|
+  config.content_type = :xml
+end
 ```
 
 ```ruby
-    '<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status)
+'<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status)
 ```
 
-Using the with method:
+Using the `with` method:
 
 ```ruby
-    '<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status).with('paid')
+'<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status).with('paid')
 ```
 
-Or you can use the **have_xml_node** matcher:
+Or you can use the `have_xml_node` matcher:
 
 ```ruby
-    "<error>Transaction error: Name can't be blank</error>".should have_xml_node(:error).with("Transaction error: Name can't be blank")
+"<error>Transaction error: Name can't be blank</error>".should have_xml_node(:error).with("Transaction error: Name can't be blank")
 ```
 
 To see the xml node and see if include a text, you can do this:
 
 ```ruby
-    "<error>Transaction error: Name can't be blank</error>".should have_xml_node(:error).including_text("Transaction error")
+"<error>Transaction error: Name can't be blank</error>".should have_xml_node(:error).including_text("Transaction error")
 ```
 
-**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.**
+**If you work with xml and json in the same API, check the have_json_node and have_xml_node matchers.**
 
-You can configure the name of the method for example:
+You can configure the name of the method and then you will be able to use *without* the **#body** method, for example:
 
 ```ruby
-      ## Instead of this
-      response.body.should have_node(:foo)
+APIMatchers.setup do |config|
+  config.response_body_method = :body
+end
+
+response.should have_node(:foo).with('bar')
 ```
 
-```ruby
-      ## YOU can do this
-      APIMatchers.setup do |config|
-        config.response_body_method = :body
-      end
+# Instead of:
+response.body.should have_node(:foo)
 ```
 
-Then you can use *without* call the **#body** method:
+### Have JSON Node Matcher
 
 ```ruby
-      response.should have_node(:foo).with('bar')
+'{ "transaction": { "id": 54, "status": "paid" } }'.should have_json_node(:id).with(54)
 ```
 
-### Have JSON Node Matcher
+### Have XML Node Matcher
 
 ```ruby
-    '{ "transaction": { "id": 54, "status": "paid" } }'.should have_json_node(:id).with(54)
+"<product><name>gateway</name></product>".should have_xml_node(:name).with('gateway')
 ```
 
-### Have XML Node Matcher
+### Have JSON Matcher
+
+Sometimes, you want to compare the entire JSON structure:
 
 ```ruby
-    "<product><name>gateway</name></product>".should have_xml_node(:name).with('gateway')
+"['Foo', 'Bar', 'Baz']".should have_json(['Foo', 'Bar', 'Baz'])
 ```
 
 ### Create Resource Matcher
@@ -146,7 +158,7 @@ Then you can use *without* call the **#body** method:
 This matchers see the HTTP STATUS CODE is equal to 201.
 
 ```ruby
-     response.status.should create_resource
+response.status.should create_resource
 ```
 
 ### BAD REQUEST Matcher
@@ -154,8 +166,8 @@ This matchers see the HTTP STATUS CODE is equal to 201.
 This BAD REQUEST is a matcher that see if the HTTP STATUS code is equal to 400.
 
 ```ruby
-    response.status.should be_a_bad_request
-    response.status.should be_bad_request
+response.status.should be_a_bad_request
+response.status.should be_bad_request
 ```
 
 ### UNAUTHORIZED Matcher
@@ -163,8 +175,8 @@ This BAD REQUEST is a matcher that see if the HTTP STATUS code is equal to 400.
 This UNAUTHORIZED is a matcher that see if the HTTP STATUS code is equal to 401.
 
 ```ruby
-    response.status.should be_unauthorized
-    response.body.should have_node(:message).with('Invalid Credentials')
+response.status.should be_unauthorized
+response.body.should have_node(:message).with('Invalid Credentials')
 ```
 
 ### INTERNAL SERVER ERROR Matcher
@@ -172,8 +184,8 @@ This UNAUTHORIZED is a matcher that see if the HTTP STATUS code is equal to 401.
 This INTERNAL SERVER Error is a matcher that see if the HTTP STATUS code is equal to 500.
 
 ```ruby
-    response.status.should be_internal_server_error
-    response.body.should have_node(:message).with('An Internal Error Occurs in our precious app. :S')
+response.status.should be_internal_server_error
+response.body.should have_node(:message).with('An Internal Error Occurs in our precious app. :S')
 ```
 
 ### HTTP STATUS CODE Configuration
@@ -181,32 +193,32 @@ This INTERNAL SERVER Error is a matcher that see if the HTTP STATUS code is equa
 You can configure the name method to call the http status code:
 
 ```ruby
-     APIMatchers.setup do |config|
-       config.http_status_method = :status
-     end
+APIMatchers.setup do |config|
+  config.http_status_method = :status
+end
 ```
 
 Then you can use without call the **#status** method:
 
 ```ruby
-    response.should create_resource
+response.should create_resource
 ```
 
 This configurations affects this matchers:
 
-* be_ok
-* create_resource
-* be_a_bad_request
-* be_internal_server_error
-* be_unauthorized
-* be_not_found
+* `be_ok`
+* `create_resource`
+* `be_a_bad_request`
+* `be_internal_server_error`
+* `be_unauthorized`
+* `be_not_found`
 
 ### Be in XML Matcher
 
 This is a matcher that see if the content type is xml:
 
 ```ruby
-    response.headers['Content-Type'].should be_in_xml
+response.headers['Content-Type'].should be_in_xml
 ```
 
 ### Be in JSON Matcher
@@ -214,7 +226,7 @@ This is a matcher that see if the content type is xml:
 This is a matcher that see if the content type is in JSON:
 
 ```ruby
-    response.headers['Content-Type'].should be_in_json
+response.headers['Content-Type'].should be_in_json
 ```
 
 ### Headers Configuration
@@ -222,17 +234,17 @@ This is a matcher that see if the content type is in JSON:
 You can configure the name method to call the headers and content type:
 
 ```ruby
-    APIMatchers.setup do |config|
-      config.header_method           = :headers
-      config.header_content_type_key = 'Content-Type'
-    end
+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:
+And then you will be able to use without call the **#headers** calling the **#['Content-Type']** method:
 
 ```ruby
-    response.should be_in_json
-    response.should be_in_xml
+response.should be_in_json
+response.should be_in_xml
 ```
 
 ### Acknowlegments
@@ -242,3 +254,4 @@ Then you can use without call the **#headers** calling the **#['Content-Type']**
 ### Contributors
 
 * Stephen Orens
+* Lucas Caton

data/lib/api_matchers/core/find_in_json.rb

@@ -20,7 +20,6 @@ module APIMatchers
                 expected_value = expected_value.to_datetime.to_s
               end
             end
-
             return value if value == expected_value or expected_value.nil?
           end
 

data/lib/api_matchers/response_body/have_xml_node.rb

@@ -4,17 +4,26 @@ module APIMatchers
   module ResponseBody
     class HaveXmlNode < Base
       def matches?(actual)
+        value = false
         @actual = actual
         xml = Nokogiri::XML(response_body)
-        node = xml.xpath("//#{@expected_node}").text
 
-        if @with_value
-          node == @with_value.to_s
-        elsif @expected_including_text
-          node.to_s.include?(@expected_including_text)
-        else
-          node.present?
+        node_set = xml.xpath("//#{@expected_node}")
+        if node_set
+          node_set.each do |node|
+            if @with_value
+              value = (node.text == @with_value.to_s)
+            elsif @expected_including_text
+              value = (node.text.to_s.include?(@expected_including_text))
+            else
+              value = node.text.present?
+            end
+            # if value is true, time to return
+            return value if value
+          end
         end
+        # at this point, it failed to match
+        return value
       end
     end
   end

data/lib/api_matchers/version.rb

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

data/spec/api_matchers/response_body/have_json_spec.rb

@@ -6,6 +6,10 @@ describe APIMatchers::ResponseBody::HaveJson do
       it 'equal json' do
         ['Petshop', 'Dogs'].to_json.should have_json(['Petshop', 'Dogs'])
       end
+
+      it 'compares with Hash too' do
+        { 'offers' => [10, 90] }.to_json.should have_json({ 'offers' => [10,90] })
+      end
     end
 
     context 'when fails' do

data/spec/api_matchers/response_body/have_xml_node_spec.rb

@@ -63,6 +63,33 @@ describe APIMatchers::ResponseBody::HaveXmlNode do
         }.to fail_with(%Q{expected to have node called: 'message' including text: 'Fox on the run'. Got: '<error><message>Transaction error: Name can't be blank</message></error>'})
       end
     end
+
+    context "find matching node when multiple records" do
+      it "should pass when the expected is included in the actual (1 level)" do
+        %{<messages>
+          <message><id>4</id></message>
+          <message><id>2</id></message>
+        </messages>}.should have_xml_node(:id).with(2)
+      end
+      it "should fail when the expected is not included in the actual (1 level)" do
+        %{<messages>
+          <message><id>4</id></message>
+          <message><id>2</id></message>
+        </messages>}.should_not have_xml_node(:id).with(3)
+      end
+      it "should pass when the expected is included in the actual (2 levels)" do
+        %{<messages>
+          <message><header><id>4</id></header></message>
+          <message><header><id>2</id></header></message>
+        </messages>}.should have_xml_node(:id).with(2)
+      end
+      it "should fail when the expected is not included in the actual (2 levels)" do
+        %{<messages>
+          <message><header><id>4</id></header></message>
+          <message><header><id>2</id></header></message>
+        </messages>}.should_not have_xml_node(:id).with(3)
+      end
+    end
   end
 
   describe "actual.should_not have_xml_node" do

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: api_matchers
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tomas D'Stefano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-25 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.2.5
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.5.2
 description: Collection of RSpec matchers for create your API.
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rvmrc.example
+- .travis.yml
 - Gemfile
 - History.markdown
 - LICENSE
@@ -117,17 +118,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Collection of RSpec matchers for create your API.