rack-rest-rspec 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b81fa23d24317edb1b4fa127c8fa4419ff7601cd7e58b83199bba10a41d0f8d
-  data.tar.gz: 4b7f8469e2b0bf10f7ac2fb4c28337ad675d6565d7756cf5976f30bd048b2605
+  metadata.gz: 71ef01252294ee9e868956d7022e23990f81557cc4025940da96b2783b4c2d04
+  data.tar.gz: ab4553953c6cb4bc1f428741133889fa3defd63fa4309be087db6ba95b7f9cb8
 SHA512:
-  metadata.gz: '0538d585f4ff1c7935b53203818eda3d6ca84928df1b03add64f29211c442933f527d938e9ef7516d76c4a4a24aabb90c5f903e62c0d9ce510b4147654d2ae6a'
-  data.tar.gz: cd5bd2713cfd2314fa146c554d44b417252cbfe8b1fc2f66ec9666742e8220c390fb26508ec85abfb94278798362d9b61876f77db5efe24907c6ce2b24795b15
+  metadata.gz: 7e2fe753acd7375aa77f1672768b6c150e68df0a1f2ff5d58f68fba12c0290ea7906510b6ca29d2d877aaf4b185e80a0a50e78955c62b867b8e538445a434bfb
+  data.tar.gz: f6b5c79124bcf35173281e7b66ce0a22348d3892b7b8ff547d15c3ed1018541550712fdf97102e30e0f55fe013b10e5aca8204f67844c7ff6c282c2e083dc49e

data/README.md

@@ -19,55 +19,122 @@ or
 
 ### Basic usage : sample of spec matchers usage
 
-    describe 'Posts REST API' do
-      before :all do
-        $service = RestService::new :service => MYRack::ModularApp
-      end
-
-      subject { $service }
-      context "GET /api/v1/posts : test for a collections of Post (empty)" do
-        it { expect(subject.get('/api/v1/posts')).to be_correctly_sent }
-        it { expect(subject).to respond_with_status 200 }
-        it { expect(subject).to respond_a_collection_of_record }
-        it { expect(subject).to respond_with_collection_size 0 }
-      end
-
-      context "POST /api/v1/post : create a new record" do
-        it { expect(subject.post('/api/v1/post',{id: 1, title: "test", body: "content"}.to_json)).to be_correctly_sent }
-        it { expect(subject).to respond_with_status 201 }
-      end
-
-      context "GET /api/v1/posts : test for a collections of Post" do
-        it { expect(subject.get('/api/v1/posts')).to be_correctly_sent }
-   	it { expect(subject).to respond_with_status 200 }
-        it { expect(subject).to respond_a_collection_of_record }
-        it { expect(subject).to respond_with_collection_size 1 }
-      end
-
-      context "GET /api/v1/post/:id : get a record by code" do
-        it { expect(subject.get("/api/v1/post/1")).to be_correctly_sent }
-        it { expect(subject).to respond_with_status 200 }
-        it { expect(subject).to respond_a_record }
-        it { expect(subject).to respond_with_data({id: 1, title: "test", body: "content"}) }
-      end
-
-      context "DELETE /api/v1/post/:id : delete a pots by id" do
-        it{ expect(subject.delete("/api/v1/post/1")).to be_correctly_sent }
-        it { expect(subject).to respond_with_status 204 }
-      end
+Considering this API made with [Sinatra](https://sinatrarb.com/) :
 
 
+```ruby
+class Application < Sinatra::Base
 
+
+    before do
+        content_type 'application/json'
+    end
+
+    get '/status' do
+        status 208
+        return {name: "Sample App", version: "0.0.1", status: 'OK'}.to_json
+    end
+
+    get '/embeded_status' do
+        status 208
+        return {code: 208, data: {name: "Sample App", version: "0.0.1", status: 'OK'}}.to_json
+    end
+
+    get '/collection' do
+        return [{one: 1}, {two: 2}, {three: 3}].to_json
+    end
+
+    get '/embeded_collection' do
+        return {code: 200, data: [{one: 1}, {two: 2}, {three: 3}]}.to_json
+    end
+
+end
+```
+
+You could test this with rack-rest-rspec :
+
+```ruby
+describe 'Test REST API' do
+    before :all do
+      $service = RestService::new :service => Application
+      $data = {name: "Sample App", version: "0.0.1", status: 'OK'}
+      $collection = [{one: 1}, {two: 2}, {three: 3}]
+    end
+  
+    subject { $service }
+    context "GET /status : test for status" do
+      it { expect(subject.get('/status')).to be_correctly_sent }
+      it { expect(subject).to respond_with_status code: 208 }
+      it { expect(subject).to respond_a_record }
+      it { expect(subject).to respond_with data: $data }
+    end
+
+    context "GET /embeded_status : test for status" do
+      it { expect(subject.get('/embeded_status')).to be_correctly_sent }
+      it { expect(subject).to respond_with_status code: 208 }
+      it { expect(subject).to respond_a_record root: :data }
+      it { expect(subject).to respond_with data: $data, root: :data } 
+    end
+    
+
+    context "GET /collection : test for Array" do
+      it { expect(subject.get('/collection')).to be_correctly_sent }
+      it { expect(subject).to respond_with_status code: 200 }
+      it { expect(subject).to respond_a_collection_of_record }
+      it { expect(subject).to respond_with_collection size: 3 }
+      it { expect(subject).to respond_with data: $collection }
+    end
+
+
+    context "GET /embeded_collection : test for Array" do
+      it { expect(subject.get('/embeded_collection')).to be_correctly_sent }
+      it { expect(subject).to respond_with_status code: 200 }
+      it { expect(subject).to respond_a_collection_of_record root: :data}
+      it { expect(subject).to respond_with_collection size: 3,root: :data }
+      it { expect(subject).to respond_with data: $collection, root: :data }
     end
 
+  
+  end
+```
+Output :
+
+```
+Test REST API
+  GET /status : test for status
+    is expected to be a valid HTTP verb request with a valid response return
+    is expected to respond with status code equal to 208
+    is expected to respond with a record (Hash)
+    is expected to respond with corresponding data
+  GET /embeded_status : test for status
+    is expected to be a valid HTTP verb request with a valid response return
+    is expected to respond with status code equal to 208
+    is expected to respond with a record (Hash)
+    is expected to respond with corresponding data
+  GET /collection : test for Array
+    is expected to be a valid HTTP verb request with a valid response return
+    is expected to respond with status code equal to 200
+    is expected to respond with a records collection (Array)
+    is expected to respond with a collection of records size of 3
+    is expected to respond with corresponding data
+  GET /embeded_collection : test for Array
+    is expected to be a valid HTTP verb request with a valid response return
+    is expected to respond with status code equal to 200
+    is expected to respond with a records collection (Array)
+    is expected to respond with a collection of records size of 3
+    is expected to respond with corresponding data
+
+Finished in 0.01585 seconds (files took 0.25845 seconds to load)
+18 examples, 0 failures
+```
 
 ## Available matchers :
 
 * be_correctly_send : check if return is HTTP valid
-* respond_with_a_collection_of_record : check if the return is a JSON Array
-* respond_a_record : check if the return is a JSON Hash
-* respond_with_collection_size <Integer> : check if the collection have the good size
-* respond_with_data <Object> : check if the return match the given object
+* respond_with_a_collection_of_record OPTIONAL[root: <:symbol>] : check if the return is a JSON Array, could be chroot with root:
+* respond_a_record OPTIONAL[root: <:symbol>] : check if the return is a JSON Hash, could be chroot with root:
+* respond_with_collection size: <Integer> OPTIONAL[root: <:symbol>] : check if the collection have the good size, could be chroot with root:
+* respond_with  data: <Object> OPTIONAL[root: <:symbol>] : check if the return match the given object, could be chroot with root:
 * respond_with_status <Integer> : check if the HTTP response code is the good.
 
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/rack-rest-rspec/matchers/respond_a_collection_of_record.rb

@@ -1,14 +1,21 @@
-RSpec::Matchers.define :respond_a_collection_of_record do
+RSpec::Matchers.define :respond_a_collection_of_record do |options= {}|
+  
   match do |actual|
-    JSON::parse(actual.browser.last_response.body).class == Array
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
+    result.class == Array
   end
   description do
-    "respond with a record collection (Array)"
+    "respond with a records collection (Array)"
   end
   failure_message do |actual|
-    "expected #{actual} response body would be a collection \nneed : Array, \ngot  : #{JSON::parse(actual.browser.last_response.body).class}"
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:oot].nil?
+    "expected #{actual} response body would be a collection \nneed : Array, \ngot  : #{result.class}"
   end
   failure_message_when_negated do |actual|
-    "expected #{actual} response body would not be a collection \nneed : Array, \ngot  : #{JSON::parse(actual.browser.last_response.body).class}"
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
+    "expected #{actual} response body would not be a collection \nneed : Array, \ngot  : #{result.class}"
   end
 end

data/lib/rack-rest-rspec/matchers/respond_a_record.rb

@@ -1,14 +1,20 @@
-RSpec::Matchers.define :respond_a_record do
+RSpec::Matchers.define :respond_a_record do |options={}|
   match do |actual|
-    JSON::parse(actual.browser.last_response.body).class == Hash
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
+    result.class == Hash
   end
   description do
     "respond with a record (Hash)"
   end
   failure_message do |actual|
-    "expected #{actual} response body would be a record \nneed : Hash, \ngot  : #{JSON::parse(actual.browser.last_response.body).class}"
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
+    "expected #{actual} response body would be a record \nneed : Hash, \ngot  : #{result.class}"
   end
   failure_message_when_negated do |actual|
-    "expected #{actual} response body would not be a record \nneed : Hash, \ngot  : #{JSON::parse(actual.browser.last_response.body).class}"
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
+    "expected #{actual} response body would not be a record \nneed : Hash, \ngot  : #{result.class}"
   end
 end

data/lib/rack-rest-rspec/matchers/respond_with_collection_size.rb

@@ -1,14 +1,22 @@
-RSpec::Matchers.define :respond_with_collection_size do |expected|
+RSpec::Matchers.define :respond_with_collection do |options={}|
+  expected = options[:size]
   match do |actual|
-    JSON::parse(actual.browser.last_response.body).size == expected
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
+    result.size == expected
   end
   description do
-    "respond with a collection of record size of #{expected}"
+    "respond with a collection of records size of #{expected}"
   end
+
   failure_message do |actual|
-    "expected #{actual} response body collection would have a size of #{expected}, \ngot #{JSON::parse(actual.browser.last_response.body).size}"
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil? 
+    "expected #{actual} response body collection would have a size of #{expected}, \ngot #{result.size}"
   end
   failure_message_when_negated do |actual|
-    "expected #{actual} response body collection would not have a size of #{expected}, \ngot #{JSON::parse(actual.browser.last_response.body).size}"
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
+    "expected #{actual} response body collection would not have a size of #{expected}, \ngot #{result.size}"
   end
 end

data/lib/rack-rest-rspec/matchers/respond_with_data.rb

@@ -11,22 +11,18 @@ def compare_array_of_hash expected, actual
 end
 
 def prepare_array data
-  data = (data.class == Hash)? [data] : data
-  data.each do |ahash|
-    ahash.symbolize!
-  end
-  return data
+  return (data.class == Hash)? [data] : data
 end
 
 
-RSpec::Matchers.define :respond_with_data do |expected|
-  result = ""
+RSpec::Matchers.define :respond_with do |options={}|
+  expected = options[:data]
   match do |actual|
-    result = actual.browser.last_response.body
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
     if result.empty? then
       false 
     else
-      result = JSON::parse(result)
       result = prepare_array result
       expected = prepare_array expected
       compare_array_of_hash expected,result
@@ -36,9 +32,13 @@ RSpec::Matchers.define :respond_with_data do |expected|
     "respond with corresponding data"
   end
   failure_message do |actual|
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
     "expected #{actual} response body would be equal \nto  : #{expected}, \ngot : #{result}"
   end
   failure_message_when_negated do |actual|
+    result = JSON::parse(actual.browser.last_response.body, symbolize_names: true)
+    result  = result[options[:root]] unless options[:root].nil?
     "expected #{actual} response body would not be equal \nto  : #{expected}, \ngot : #{result}"
   end
 end

data/lib/rack-rest-rspec/matchers/respond_with_status.rb

@@ -1,14 +1,18 @@
-RSpec::Matchers.define :respond_with_status do |expected|
+RSpec::Matchers.define :respond_with_status do |options={}|
+  expected = options[:code]
   match do |actual|
-    actual.browser.last_response.status == expected
+    result = actual.browser.last_response 
+    result.status == expected
   end
   description do
     "respond with status code equal to #{expected}"
   end
   failure_message do |actual|
-    "expected #{actual} response would be equal \nto  : #{expected} \ngot : #{actual.browser.last_response.status}"
+    result = actual.browser.last_response
+    "expected #{actual} response would be equal \nto  : #{expected} \ngot : #{result.status}"
   end
   failure_message_when_negated do |actual|
-    "expected #{actual} response would not be equal \nto  : #{expected} \ngot : #{actual.browser.last_response.status}"
+    result = actual.browser.last_response
+    "expected #{actual} response would not be equal \nto  : #{expected} \ngot : #{result.status}"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-rest-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roodi