api_matchers 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8551de9e183566d4d82c9826172b6a181a6daf74
-  data.tar.gz: d3caa8d552bb7f52708b80675b36a051b8f91464
+  metadata.gz: d882c54ce0bc594825cb011faec59a541294bb02
+  data.tar.gz: a0c3239ed282e344679a2a1db654196dc6cb2395
 SHA512:
-  metadata.gz: 2d1b9058f255957ad59f53098e2287c26c09c5cd0bc1a76bf2aae1cb7e1f0acfdcf541d32dddf5c38450894aeb5c9018ac57a4a1cf6033b6b1ea0e4f7dfa9afc
-  data.tar.gz: 133ca4527a7a9f2e166ae16826bef9ce6420d170e1b7f0bbbfe67ad1fb6562bb14a7f7c79a1f52f36e64b571bfb0262c7fd03887487621f02d6dbdcb50a0c740
+  metadata.gz: 815e34c991334a26b37a6e6616bde1ba1feec76faddbfc90e17f00009a7289ffa50db7c0ea01e86fb026cdf80f9519811b8ec5122e4aab37db5ba309a743733a
+  data.tar.gz: 29419d2f053a10c835ca4b3531f79f49e958bf7649bcd94530a298cebbc8156fc3e2d9f429fefcf2f0c5984af4969cb9faf0f2c65990f9709c2fc89a3dda5ddd

data/.travis.yml

@@ -1,10 +1,12 @@
 language: ruby
+script:
+  - bundle exec rspec spec
 rvm:
-  - 1.9.3
-  - 2.0
+  - rbx-2
+  - jruby-head
+  - ruby-head
+  - ruby
   - jruby
-before_install:
-  - export DISPLAY=:99.0
-  - sh -e /etc/init.d/xvfb start
-script:
-  - bundle exec rspec
+  - 2.1.2
+  - 2.0.0
+  - 1.9.3

data/History.markdown

@@ -1,3 +1,13 @@
+## 0.6.0
+
+* Add be_forbidden matcher:
+
+```ruby
+  expect(response.status).to be_forbidden
+```
+
+* Add RSpec 3 and RSpec 2 compatibility.
+
 ## 0.5.1
 
 * Fix #have_json matcher fail message. Fix issue #20

data/README.markdown

@@ -15,6 +15,7 @@ Collection of RSpec matchers for your API.
 * `create_resource`
 * `be_a_bad_request`
 * `be_unauthorized`
+* `be_forbidden`
 * `be_internal_server_error`
 * `be_not_found`
 
@@ -56,33 +57,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)
+expect('{ "transaction": { "id": 54, "status": "paid" } }').to have_node(:transaction)
 ```
 
 Or if node exist with a value:
 
 ```ruby
-'{ "transaction": { "id": 54, "status": "paid" } }'.should have_node(:id).with(54)
+expect('{ "transaction": { "id": 54, "status": "paid" } }').to have_node(:id).with(54)
 ```
 
 ```ruby
-'{ "error": "not_authorized" }'.should have_node(:error).with('not_authorized')
+expect('{ "error": "not_authorized" }').to have_node(:error).with('not_authorized')
 ```
 
 ```ruby
-'{"parcels":1 }'.should have_node(:parcels).with(1)
+expect('{"parcels":1 }').to 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")
+expect('{"error": "Transaction error: Name cant be blank"}').to have_node(:error).including_text("Transaction error")
 ```
 
 You can verify boolean values too:
 
 ```ruby
-'{"creditcard":true}'.should have_node(:creditcard).with(true)
+expect('{"creditcard":true}').to have_node(:creditcard).with(true)
 ```
 
 ### HAVE NODE Matcher Configuration
@@ -96,25 +97,25 @@ end
 ```
 
 ```ruby
-'<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status)
+expect('<transaction><id>200</id><status>paid</status></transaction>').to have_node(:status)
 ```
 
 Using the `with` method:
 
 ```ruby
-'<transaction><id>200</id><status>paid</status></transaction>'.should have_node(:status).with('paid')
+expect('<transaction><id>200</id><status>paid</status></transaction>').to have_node(:status).with('paid')
 ```
 
 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")
+expect("<error>Transaction error: Name can't be blank</error>").to 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")
+expect("<error>Transaction error: Name can't be blank</error>").to have_xml_node(:error).including_text("Transaction error")
 ```
 
 **If you work with xml and json in the same API, check the have_json_node and have_xml_node matchers.**
@@ -126,25 +127,25 @@ APIMatchers.setup do |config|
   config.response_body_method = :body
 end
 
-response.should have_node(:foo).with('bar')
+expect(response).to have_node(:foo).with('bar')
 ```
 
 Instead of:
 
 ```ruby
-response.body.should have_node(:foo)
+expect(response.body).to have_node(:foo)
 ```
 
 ### Have JSON Node Matcher
 
 ```ruby
-'{ "transaction": { "id": 54, "status": "paid" } }'.should have_json_node(:id).with(54)
+expect('{ "transaction": { "id": 54, "status": "paid" } }').to have_json_node(:id).with(54)
 ```
 
 ### Have XML Node Matcher
 
 ```ruby
-"<product><name>gateway</name></product>".should have_xml_node(:name).with('gateway')
+expect("<product><name>gateway</name></product>").to have_xml_node(:name).with('gateway')
 ```
 
 ### Have JSON Matcher
@@ -152,7 +153,7 @@ response.body.should have_node(:foo)
 Sometimes, you want to compare the entire JSON structure:
 
 ```ruby
-"['Foo', 'Bar', 'Baz']".should have_json(['Foo', 'Bar', 'Baz'])
+expect("['Foo', 'Bar', 'Baz']").to have_json(['Foo', 'Bar', 'Baz'])
 ```
 
 ### Create Resource Matcher
@@ -160,7 +161,7 @@ Sometimes, you want to compare the entire JSON structure:
 This matchers see the HTTP STATUS CODE is equal to 201.
 
 ```ruby
-response.status.should create_resource
+expect(response.status).to create_resource
 ```
 
 ### BAD REQUEST Matcher
@@ -168,8 +169,8 @@ response.status.should create_resource
 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
+expect(response.status).to be_a_bad_request
+expect(response.status).to be_bad_request
 ```
 
 ### UNAUTHORIZED Matcher
@@ -177,8 +178,16 @@ response.status.should be_bad_request
 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')
+expect(response.status).to be_unauthorized
+expect(response.body).to have_node(:message).with('Invalid Credentials')
+```
+
+### FORBIDDEN Matcher
+
+This is a matcher to see if the HTTP STATUS code is equal to 403.
+
+```ruby
+expect(response.status).to be_forbidden
 ```
 
 ### INTERNAL SERVER ERROR Matcher
@@ -186,8 +195,8 @@ response.body.should have_node(:message).with('Invalid Credentials')
 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')
+expect(response.status).to be_internal_server_error
+expect(response.body).to have_node(:message).with('An Internal Error Occurs in our precious app. :S')
 ```
 
 ### HTTP STATUS CODE Configuration
@@ -203,7 +212,7 @@ end
 Then you can use without call the **#status** method:
 
 ```ruby
-response.should create_resource
+expect(response).to create_resource
 ```
 
 This configurations affects this matchers:
@@ -213,6 +222,7 @@ This configurations affects this matchers:
 * `be_a_bad_request`
 * `be_internal_server_error`
 * `be_unauthorized`
+* `be_forbidden`
 * `be_not_found`
 
 ### Be in XML Matcher
@@ -220,7 +230,7 @@ This configurations affects this matchers:
 This is a matcher that see if the content type is xml:
 
 ```ruby
-response.headers['Content-Type'].should be_in_xml
+expect(response.headers['Content-Type']).to be_in_xml
 ```
 
 ### Be in JSON Matcher
@@ -228,7 +238,7 @@ response.headers['Content-Type'].should be_in_xml
 This is a matcher that see if the content type is in JSON:
 
 ```ruby
-response.headers['Content-Type'].should be_in_json
+expect(response.headers['Content-Type']).to be_in_json
 ```
 
 ### Headers Configuration
@@ -245,8 +255,8 @@ end
 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
+expect(response).to be_in_json
+expect(response).to be_in_xml
 ```
 
 ### Acknowlegments

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.14'
+  gem.add_dependency 'rspec', '~> 3.1'
   gem.add_dependency 'activesupport', '>= 3.2.5'
   gem.add_dependency 'nokogiri', '>= 1.5.2'
 end

data/lib/api_matchers/core/rspec_matchers.rb

@@ -18,6 +18,10 @@ module APIMatchers
       ::APIMatchers::HTTPStatusCode::BeUnauthorized.new(::APIMatchers::Core::Setup)
     end
 
+    def be_forbidden
+      ::APIMatchers::HTTPStatusCode::BeForbidden.new(::APIMatchers::Core::Setup)
+    end
+
     def be_ok
       ::APIMatchers::HTTPStatusCode::BeOk.new(::APIMatchers::Core::Setup)
     end

data/lib/api_matchers/http_status_code/be_forbidden.rb

@@ -0,0 +1,21 @@
+module APIMatchers
+  module HTTPStatusCode
+    class BeForbidden < Base
+      def expected_status_code
+        403
+      end
+
+      def failure_message
+        %Q{expected that '#{@http_status_code}' to be Forbidden with the status '403'.}
+      end
+
+      def failure_message_when_negated
+        %Q{expected that '#{@http_status_code}' to NOT be Forbidden.}
+      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.5.1"
+  VERSION = '0.6.0'
 end

data/lib/api_matchers.rb

@@ -15,6 +15,7 @@ module APIMatchers
     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 :BeForbidden, 'api_matchers/http_status_code/be_forbidden'
     autoload :CreateResource, 'api_matchers/http_status_code/create_resource'
   end
 

data/spec/api_matchers/core/find_in_json_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module APIMatchers::Core
-  describe FindInJSON do
+  RSpec.describe FindInJSON do
     describe "#find" do
       context 'when node exists' do
         it "should return the value of the expected key" do

data/spec/api_matchers/core/setup_spec.rb

@@ -1,4 +1,4 @@
 require 'spec_helper'
 
-describe APIMatchers::Core::Setup do
+RSpec.describe APIMatchers::Core::Setup do
 end

data/spec/api_matchers/headers/base_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::Headers::Base do
+RSpec.describe APIMatchers::Headers::Base do
   let(:setup) { OpenStruct.new }
   subject { APIMatchers::Headers::Base.new(setup) }
 

data/spec/api_matchers/headers/be_json_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::Headers::BeJSON do
+RSpec.describe APIMatchers::Headers::BeJSON do
   describe "actual.to be_json" do
     it "should pass when the actual is json response" do
       expect("application/json; charset=utf-8").to be_json

data/spec/api_matchers/headers/be_xml_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::Headers::BeXML do
+RSpec.describe APIMatchers::Headers::BeXML do
   describe "actual.to be_xml" do
     it "should pass when the actual is json response" do
       expect("application/xml; charset=utf-8").to be_xml

data/spec/api_matchers/http_status_code/base_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::Base do
+RSpec.describe APIMatchers::HTTPStatusCode::Base do
   let(:setup) { OpenStruct.new }
   subject { APIMatchers::HTTPStatusCode::Base.new(setup) }
 

data/spec/api_matchers/http_status_code/be_bad_request_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::BeBadRequest do
+RSpec.describe APIMatchers::HTTPStatusCode::BeBadRequest do
   describe "should be_bad_request" do
     it "should passes if the actual is equal to 400" do
       expect(400).to be_bad_request

data/spec/api_matchers/http_status_code/be_forbidden_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+RSpec.describe APIMatchers::HTTPStatusCode::BeForbidden do
+  describe "should be_forbidden" do
+    it "should passes if the actual is equal to 403" do
+      expect(403).to be_forbidden
+    end
+
+    it "should fails if the actual is not equal to 403" do
+      expect {
+        expect(400).to be_forbidden
+      }.to fail_with(%Q{expected that '400' to be Forbidden with the status '403'.})
+    end
+  end
+
+  describe "should_not be_forbidden" do
+    it "should pass if the actual is not equal to 403" do
+      expect(201).not_to be_forbidden
+    end
+
+    it "should fail if the actual is equal to 403" do
+      expect {
+        expect(403).not_to be_forbidden
+      }.to fail_with(%Q{expected that '403' to NOT be Forbidden.})
+    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 403" do
+      response = OpenStruct.new(:http_status => 403)
+      expect(response).to be_forbidden
+    end
+
+    it "should fail if the actual.http_status is not equal to 403" do
+      response = OpenStruct.new(:http_status => 402)
+      expect {
+        expect(response).to be_forbidden
+      }.to fail_with(%Q{expected that '402' to be Forbidden with the status '403'.})
+    end
+  end
+end

data/spec/api_matchers/http_status_code/be_internal_server_error_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::BeInternalServerError do
+RSpec.describe APIMatchers::HTTPStatusCode::BeInternalServerError do
   describe "should be_internal_server_error" do
     it "should passes if the actual is equal to 500" do
       expect(500).to be_internal_server_error

data/spec/api_matchers/http_status_code/be_not_found_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::BeBadRequest do
+RSpec.describe APIMatchers::HTTPStatusCode::BeBadRequest do
   describe "should be_not_found" do
     it "should passes if the actual is equal to 404" do
       expect(404).to be_not_found
@@ -14,7 +14,7 @@ describe APIMatchers::HTTPStatusCode::BeBadRequest do
   end
 
   describe "should_not be_not_found" do
-    it "should passes if the actual is not equal to 404" do
+    it "should pass if the actual is not equal to 404" do
       expect(401).not_to be_not_found
     end
 

data/spec/api_matchers/http_status_code/be_ok_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::BeOk do
+RSpec.describe APIMatchers::HTTPStatusCode::BeOk do
   describe "should be_ok" do
     it "should passes if the actual is equal to 200" do
       expect(200).to be_ok

data/spec/api_matchers/http_status_code/be_unauthorized_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::BeUnauthorized do
+RSpec.describe APIMatchers::HTTPStatusCode::BeUnauthorized do
   describe "should be_unauthorized" do
     it "should passes if the actual is equal to 401" do
       expect(401).to be_unauthorized
@@ -14,11 +14,11 @@ describe APIMatchers::HTTPStatusCode::BeUnauthorized do
   end
 
   describe "should_not be_unauthorized" do
-    it "should passes if the actual is not equal to 401" do
+    it "should pass if the actual is not equal to 401" do
       expect(201).not_to be_unauthorized
     end
 
-    it "should fail if the actual is equal equal to 401" do
+    it "should fail if the actual is equal to 401" do
       expect {
         expect(401).not_to be_unauthorized
       }.to fail_with(%Q{expected that '401' to NOT be Unauthorized.})

data/spec/api_matchers/http_status_code/be_unprocessable_entity_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::BeUnprocessableEntity do
+RSpec.describe APIMatchers::HTTPStatusCode::BeUnprocessableEntity do
   describe "should be_unprocessable_entity" do
     it "should passes if the actual is equal to 422" do
       expect(422).to be_unprocessable_entity

data/spec/api_matchers/http_status_code/create_resource_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::HTTPStatusCode::CreateResource do
+RSpec.describe APIMatchers::HTTPStatusCode::CreateResource do
   describe "should create_resource" do
     it "should passes if the actual is equal to 201" do
       expect(201).to create_resource

data/spec/api_matchers/response_body/base_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::ResponseBody::Base do
+RSpec.describe APIMatchers::ResponseBody::Base do
   let(:setup) { OpenStruct.new(:response_body_method => :body) }
   subject { APIMatchers::ResponseBody::Base.new(setup: setup, expected_node: :status) }
 

data/spec/api_matchers/response_body/have_json_node_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::ResponseBody::HaveJsonNode do
+RSpec.describe APIMatchers::ResponseBody::HaveJsonNode do
   describe "actual).to have_json_node" do
     context 'expected key and value in top level' do
       it "pass when the expected key exist" do

data/spec/api_matchers/response_body/have_json_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::ResponseBody::HaveJson do
+RSpec.describe APIMatchers::ResponseBody::HaveJson do
   describe "actual).to have_json" do
     context 'when pass' do
       it 'equal json' do

data/spec/api_matchers/response_body/have_node_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::ResponseBody::HaveNode do
+RSpec.describe APIMatchers::ResponseBody::HaveNode do
   describe "in json" do
     before do
       APIMatchers.setup { |config| config.have_node_matcher = :json }

data/spec/api_matchers/response_body/have_xml_node_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe APIMatchers::ResponseBody::HaveXmlNode do
+RSpec.describe APIMatchers::ResponseBody::HaveXmlNode do
   describe "actual).to have_xml_node" do
     context 'expected key and value in top level' do
       it "should pass when the expected key exist" do

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
+require 'active_support'
 require 'api_matchers'
 require 'ostruct'
 
 RSpec.configure do |config|
+  config.disable_monkey_patching!
   config.include APIMatchers::RSpecMatchers
 
   def fail_with(message)

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: api_matchers
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Tomas D'Stefano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,7 @@ files:
 - lib/api_matchers/headers/be_xml.rb
 - 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_forbidden.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
@@ -100,6 +101,7 @@ files:
 - spec/api_matchers/headers/be_xml_spec.rb
 - 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_forbidden_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
@@ -143,6 +145,7 @@ test_files:
 - spec/api_matchers/headers/be_xml_spec.rb
 - 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_forbidden_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