api_matchers 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mjc1NTQ2NTNjYTFlNTc1OWZhMmFlZTVlOTBjNTc3ODhjYzdmZGY1Mw==
+  data.tar.gz: !binary |-
+    MjlhYzlkMDRhZjA5YmU3YWExNTZlNTY3MTdhNzBhODFhOTA2OGJmOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YjViMzY4MjgxNmI1NjI3MmI3MDAwZWNjMzQwYzJhMzhjNWU4MTc2YjNmYTVk
+    Y2JhMGZmNWRhYTRiN2Q0OTQ4NjdlZDlmNDMwNjEzMzU5NGY1NzNiOGU2MjE0
+    YThhZmZlM2U3NTNkNDcwNmMyZTJmM2U4NTI0ODViYzA4ZWMwNTc=
+  data.tar.gz: !binary |-
+    NDYzYThkMzYwYzE2YTlkM2MzY2FiOWMyOWJlZGM2MGVjZTU4MmQ3OTYzM2Zm
+    ODgyY2NiMmMwNGJlY2Q3MWQyNTAzZWMxNTg2ZTIwYmU3YzYxNWI1NjNkMWY3
+    ODE0YTIwZjk2YjAzOGJjYTc0YmU5MDkwYmU2ODc0YmU4YTMzYWQ=

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-*.DS_Store
+*.DS_Store
+.rvmrc

data/README.markdown

@@ -2,19 +2,25 @@
 
 Collection of RSpec matchers for create your API.
 
-## Matchers
+## Response Body Matchers
 
-* be_in_xml
-* be_a_json
+* have_node
+* have_json_node
+* have_xml_node
+
+# Response Status Matchers
+
+* be_ok_
 * create_resource
 * be_a_bad_request
 * be_unauthorized
 * be_internal_server_error
-* have_node
-* have_json_node
-* have_xml_node
-* be_json_eql
-* be_xml_eql
+* be_not_found
+
+# Other Matcher
+
+* be_in_xml
+* be_a_json
 
 ## Install
 
@@ -40,17 +46,17 @@ 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', 'transaction': { 'id': '55' } }".should have_node(:error).with('not_authorized')
+    '{ "error": "not_authorized" }'.should have_node(:error).with('not_authorized')
 ```
 
 ```ruby
@@ -71,13 +77,13 @@ You can verify boolean values too:
 
 ### HAVE NODE Matcher Configuration
 
-You can configure if you want xml(**JSON is the default**):
+You can configure if you want xml (JSON is the default):
 
 ```ruby
       APIMatchers.setup do |config|
         config.content_type = :xml
       end
-```ruby
+```
 
 ```ruby
     '<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status)
@@ -113,7 +119,7 @@ You can configure the name of the method for example:
 ```ruby
       ## YOU can do this
       APIMatchers.setup do |config|
-        config.body_method = :body
+        config.response_body_method = :body
       end
 ```
 
@@ -126,7 +132,7 @@ Then you can use *without* call the **#body** method:
 ### Have JSON Node Matcher
 
 ```ruby
-    "{ 'transaction': { 'id': '54', 'status': 'paid' } }".should have_json_node(:id).with(54)
+    '{ "transaction": { "id": 54, "status": "paid" } }'.should have_json_node(:id).with(54)
 ```
 
 ### Have XML Node Matcher
@@ -188,10 +194,12 @@ Then you can use without call the **#status** method:
 
 This configurations affects this matchers:
 
+* be_ok
 * create_resource
 * be_a_bad_request
 * be_internal_server_error
 * be_unauthorized
+* be_not_found
 
 ### Be in XML Matcher
 
@@ -233,4 +241,4 @@ Then you can use without call the **#headers** calling the **#['Content-Type']**
 
 ### Contributors
 
-* Stephen Orens
+* Stephen Orens

data/TODO.markdown

@@ -0,0 +1,2 @@
+* Refactor Core::FindInJSON#find method.
+* Adding some include matcher about node arrays.

data/lib/api_matchers/core/exceptions.rb

@@ -1,8 +1,11 @@
 module APIMatchers
   module Core
-  	module Exceptions
-		class KeyNotFound < StandardError
-  		end
-  	end
+    module Exceptions
+      class KeyNotFound < StandardError
+      end
+
+      class InvalidJSON < StandardError
+      end
+    end
   end
 end

data/lib/api_matchers/core/find_in_json.rb

@@ -23,6 +23,7 @@ module APIMatchers
 
             return value if value == expected_value or expected_value.nil?
           end
+
           # do we have more to recurse through?
           keep_going = nil
           if value.is_a? Hash or value.is_a? Array

data/lib/api_matchers/core/rspec_matchers.rb

@@ -5,6 +5,10 @@ module APIMatchers
     end
     alias :be_a_bad_request :be_bad_request
 
+    def be_not_found
+      ::APIMatchers::HTTPStatusCode::BeNotFound.new(::APIMatchers::Core::Setup)
+    end
+
     def be_internal_server_error
       ::APIMatchers::HTTPStatusCode::BeInternalServerError.new(::APIMatchers::Core::Setup)
     end
@@ -14,6 +18,10 @@ module APIMatchers
       ::APIMatchers::HTTPStatusCode::BeUnauthorized.new(::APIMatchers::Core::Setup)
     end
 
+    def be_ok
+      ::APIMatchers::HTTPStatusCode::BeOk.new(::APIMatchers::Core::Setup)
+    end
+
     def create_resource
       ::APIMatchers::HTTPStatusCode::CreateResource.new(::APIMatchers::Core::Setup)
     end

data/lib/api_matchers/http_status_code/be_not_found.rb

@@ -0,0 +1,17 @@
+module APIMatchers
+  module HTTPStatusCode
+    class BeNotFound < Base
+      def expected_status_code
+        404
+      end
+
+      def failure_message_for_should
+        %Q{expected that '#{@http_status_code}' to be Not Found with the status '404'.}
+      end
+
+      def failure_message_for_should_not
+        %Q{expected that '#{@http_status_code}' to NOT be Not Found with the status '404'.}
+      end
+    end
+  end
+end

data/lib/api_matchers/http_status_code/be_ok.rb

@@ -0,0 +1,17 @@
+module APIMatchers
+  module HTTPStatusCode
+    class BeOk < Base
+      def expected_status_code
+        200
+      end
+
+      def failure_message_for_should
+        %Q{expected that '#{@http_status_code}' to be ok with the status '200'.}
+      end
+
+      def failure_message_for_should_not
+        %Q{expected that '#{@http_status_code}' to NOT be ok with the status '200'.}
+      end
+    end
+  end
+end

data/lib/api_matchers/response_body/have_json_node.rb

@@ -6,32 +6,25 @@ module APIMatchers
     class HaveJsonNode < Base
       def matches?(actual)
         @actual = actual
-        json = begin
-          JSON.parse(response_body)
-        rescue
-          {}
-        end
 
         begin
-          options = {}
-          options[:node] = @expected_node.to_s
-          unless @with_value.nil?
-            options[:value] = @with_value
-          end
-
-          node = Core::FindInJSON.new(json).find( options )
+          node = Core::FindInJSON.new(json).find(node: @expected_node.to_s, value: @with_value)
 
           if @expected_including_text
             node.to_s.include?(@expected_including_text)
           else
-            # the node is present
-            true
+            true # the node is present
           end
-        rescue ::APIMatchers::Core::Exceptions::KeyNotFound
-          # the key was not found
-          false
+        rescue ::APIMatchers::KeyNotFound
+          false # the key was not found
         end
       end
+
+      def json
+        JSON.parse(response_body)
+      rescue JSON::ParserError => exception
+        raise ::APIMatchers::InvalidJSON.new("Invalid JSON: '#{response_body}'")
+      end
     end
   end
 end

data/lib/api_matchers/version.rb

@@ -1,3 +1,3 @@
 module APIMatchers
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/api_matchers.rb

@@ -10,8 +10,10 @@ module APIMatchers
   module HTTPStatusCode
     autoload :Base, 'api_matchers/http_status_code/base'
     autoload :BeBadRequest, 'api_matchers/http_status_code/be_bad_request'
+    autoload :BeNotFound, 'api_matchers/http_status_code/be_not_found'
     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 :CreateResource, 'api_matchers/http_status_code/create_resource'
   end
 
@@ -39,6 +41,7 @@ module APIMatchers
     autoload :Setup, 'api_matchers/core/setup'
     autoload :Exceptions, 'api_matchers/core/exceptions'
   end
+  include ::APIMatchers::Core::Exceptions
 
   def self.setup
     yield(::APIMatchers::Core::Setup)

data/spec/api_matchers/http_status_code/be_not_found_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe APIMatchers::HTTPStatusCode::BeBadRequest do
+  describe "should be_not_found" do
+    it "should passes if the actual is equal to 404" do
+      404.should be_not_found
+    end
+
+    it "should fails if the actual is not equal to 404" do
+      expect { 401.should be_not_found }.to fail_with(%Q{expected that '401' to be Not Found with the status '404'.})
+    end
+  end
+
+  describe "should_not be_not_found" do
+    it "should passes if the actual is not equal to 404" do
+      401.should_not be_not_found
+    end
+
+    it "should fail if the actual is equal to 404" do
+      expect { 404.should_not be_not_found }.to fail_with(%Q{expected that '404' to NOT be Not Found with the status '404'.})
+    end
+  end
+
+  describe "with change configuration" do
+    before do
+      APIMatchers.setup { |config| config.http_status_method = :http_status }
+    end
+
+    after do
+      APIMatchers.setup { |config| config.http_status_method = nil }
+    end
+
+    it "should pass if the actual.http_status is equal to 404" do
+      response = OpenStruct.new(:http_status => 404)
+      response.should be_not_found
+    end
+
+    it "should fail if the actual.http_status is not equal to 400" do
+      response = OpenStruct.new(:http_status => 500)
+      expect { response.should be_not_found }.to fail_with(%Q{expected that '500' to be Not Found with the status '404'.})
+    end
+  end
+end

data/spec/api_matchers/http_status_code/be_ok_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe APIMatchers::HTTPStatusCode::BeOk do
+  describe "should be_ok" do
+    it "should passes if the actual is equal to 200" do
+      200.should be_ok
+    end
+
+    it "should fails if the actual is not equal to 200" do
+      expect { 201.should be_ok }.to fail_with(%Q{expected that '201' to be ok with the status '200'.})
+    end
+  end
+
+  describe "should_not be_ok_request" do
+    it "should passes if the actual is not equal to 200" do
+      201.should_not be_ok
+    end
+
+    it "should fail if the actual is equal to 200" do
+      expect { 200.should_not be_ok }.to fail_with(%Q{expected that '200' to NOT be ok with the status '200'.})
+    end
+  end
+
+  describe "with change configuration" do
+    before do
+      APIMatchers.setup { |config| config.http_status_method = :http_status }
+    end
+
+    after do
+      APIMatchers.setup { |config| config.http_status_method = nil }
+    end
+
+    it "should pass if the actual.http_status is equal to 200" do
+      response = OpenStruct.new(:http_status => 200)
+      response.should be_ok
+    end
+
+    it "should fail if the actual.http_status is not equal to 200" do
+      response = OpenStruct.new(:http_status => 500)
+      expect { response.should be_ok }.to fail_with(%Q{expected that '500' to be ok with the status '200'.})
+    end
+  end
+end

data/spec/api_matchers/response_body/have_json_node_spec.rb

@@ -61,7 +61,7 @@ describe APIMatchers::ResponseBody::HaveJsonNode do
       it "should not parse the matcher for json when you pass a xml" do
         expect {
           "<product><name>webdesk</name></product>".should have_json_node(:name).with('webdesk')
-        }.to fail_with(%Q{expected to have node called: 'name' with value: 'webdesk'. Got: '<product><name>webdesk</name></product>'})
+        }.to raise_error(APIMatchers::InvalidJSON, "Invalid JSON: '<product><name>webdesk</name></product>'")
       end
     end
 
@@ -224,6 +224,32 @@ describe APIMatchers::ResponseBody::HaveJsonNode do
     end
   end
 
+  describe "some assumptions" do
+    it "shouldn't fail" do
+      '{ "transaction": { "id": 54, "status": "paid" } }'.should have_json_node(:transaction)
+    end
+
+    it "also shouldn't fail" do
+      '{ "transaction": { "id": 54, "status": "paid" } }'.should have_json_node(:id).with(54)
+    end
+
+    it "should have json node including text" do
+      '{"error": "Transaction error: Name cant be blank"}'.should have_json_node(:error).including_text("Transaction error")
+    end
+
+    it "should have json node with boolean value" do
+      '{"creditcard": true}'.should have_json_node(:creditcard).with(true)
+    end
+
+    it "should have json node with value" do
+      '{ "error": "not_authorized", "transaction": { "id": "55" } }'.should have_node(:error).with('not_authorized')
+    end
+
+    it "should have json node with integer" do
+      '{"parcels": 1 }'.should have_node(:parcels).with(1)
+    end
+  end
+
   describe "with change configuration" do
     before do
       APIMatchers.setup { |config| config.response_body_method = :response_body }

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: api_matchers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomas D'Stefano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-08 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -67,13 +60,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
-- .rvmrc
+- .rvmrc.example
 - Gemfile
 - History.markdown
 - LICENSE
 - README.markdown
 - Rakefile
+- TODO.markdown
 - api_matchers.gemspec
 - lib/api_matchers.rb
 - lib/api_matchers/core/exceptions.rb
@@ -86,6 +79,8 @@ files:
 - lib/api_matchers/http_status_code/base.rb
 - lib/api_matchers/http_status_code/be_bad_request.rb
 - lib/api_matchers/http_status_code/be_internal_server_error.rb
+- lib/api_matchers/http_status_code/be_not_found.rb
+- lib/api_matchers/http_status_code/be_ok.rb
 - lib/api_matchers/http_status_code/be_unauthorized.rb
 - lib/api_matchers/http_status_code/create_resource.rb
 - lib/api_matchers/response_body/base.rb
@@ -101,6 +96,8 @@ files:
 - spec/api_matchers/http_status_code/base_spec.rb
 - spec/api_matchers/http_status_code/be_bad_request_spec.rb
 - spec/api_matchers/http_status_code/be_internal_server_error_spec.rb
+- spec/api_matchers/http_status_code/be_not_found_spec.rb
+- spec/api_matchers/http_status_code/be_ok_spec.rb
 - spec/api_matchers/http_status_code/be_unauthorized_spec.rb
 - spec/api_matchers/http_status_code/create_resource_spec.rb
 - spec/api_matchers/response_body/base_spec.rb
@@ -110,27 +107,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/tomas-stefano/api_matchers
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Collection of RSpec matchers for create your API.
 test_files:
 - spec/api_matchers/core/find_in_json_spec.rb
@@ -141,6 +137,8 @@ test_files:
 - spec/api_matchers/http_status_code/base_spec.rb
 - spec/api_matchers/http_status_code/be_bad_request_spec.rb
 - spec/api_matchers/http_status_code/be_internal_server_error_spec.rb
+- spec/api_matchers/http_status_code/be_not_found_spec.rb
+- spec/api_matchers/http_status_code/be_ok_spec.rb
 - spec/api_matchers/http_status_code/be_unauthorized_spec.rb
 - spec/api_matchers/http_status_code/create_resource_spec.rb
 - spec/api_matchers/response_body/base_spec.rb

data/.rspec

@@ -1 +0,0 @@
---color -f d