rack-rest-rspec 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b81fa23d24317edb1b4fa127c8fa4419ff7601cd7e58b83199bba10a41d0f8d
-  data.tar.gz: 4b7f8469e2b0bf10f7ac2fb4c28337ad675d6565d7756cf5976f30bd048b2605
+  metadata.gz: b5eeab5a42b95fad3925b35beb70d00b9b5ba87cb0813e42d45dd1f7f3f9f7da
+  data.tar.gz: bc8e33415d1fd2ebc6b9f9a4095a575c0f37c5d24792355c9c914082edeefcf6
 SHA512:
-  metadata.gz: '0538d585f4ff1c7935b53203818eda3d6ca84928df1b03add64f29211c442933f527d938e9ef7516d76c4a4a24aabb90c5f903e62c0d9ce510b4147654d2ae6a'
-  data.tar.gz: cd5bd2713cfd2314fa146c554d44b417252cbfe8b1fc2f66ec9666742e8220c390fb26508ec85abfb94278798362d9b61876f77db5efe24907c6ce2b24795b15
+  metadata.gz: a0204cb39a36df05af11f9de67cfa808d5754861de3ca86931c848a974b2f6d6c625f44e90adfdb636f708291216dfea3b59e91f651d5b53fa5642b29754e58c
+  data.tar.gz: 955bb74528ca5ec0d4945fd53564990f1ee0d9c19be86f669137dbdabeef0bedff4f99b3e0c871ba36c2b15b23512d24e4800cc18ec439829f4c354d98181afb

data/.debride_whitelist

@@ -0,0 +1,6 @@
+path
+returned_data
+service
+get_file
+memorize
+retrieve

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.3
+    - name: Getting dependencies (Bundle)
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+    - name: Running test Rspec
+      run: |
+        bundle exec rake
+    - name: Running CVE security audit 
+      run: |
+        bundle exec rake audit

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper 
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,44 @@
+AllCops:
+    NewCops: enable
+
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-05-03 14:08:48 UTC using RuboCop version 1.63.4.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 32
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+# Offense count: 3
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/rack-rest-rspec/lib/rest_service.rb'
+    - 'lib/rack-rest-rspec/version.rb'
+    - 'samples/app.rb'
+
+# Offense count: 23
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Exclude:
+    - 'lib/rack-rest-rspec/helpers/memorizer.rb'
+    - 'samples/spec/api_spec.rb'
+    - 'spec/api_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 122

data/Gemfile

@@ -1,20 +1,5 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-group :test, :development do
-  gem "roodi", "~> 5.0"
-  gem "rake", "~> 13.0"
-  gem "code_statistics", "~> 0.2.13"
-  gem "rspec", "~> 3.11"
-  gem "yard", "~> 0.9.28"
-  gem "yard-rspec", "~> 0.1"
-end
-
-gem "rack-test", "~> 2.0"
-
-
-
-gem "version", "~> 1.1"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Romain GEORGES
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -19,60 +19,221 @@ or
 
 ### Basic usage : sample of spec matchers usage
 
-    describe 'Posts REST API' do
-      before :all do
-        $service = RestService::new :service => MYRack::ModularApp
-      end
+Considering this API made with [Sinatra](https://sinatrarb.com/) :
 
-      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
+```ruby
+class Application < Sinatra::Base
 
-      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
+    before do
+        content_type 'application/json'
+    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
+    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_status <Integer> : check if the HTTP response code is the good.
+
+### be_correctly_send 
+
+* check if return is HTTP valid
+
+### respond_with_a_collection_of_record
+
+* params :  
+  - OPTIONAL[root: <:symbol>] 
+* goal : check if the return is a JSON Array, could be chroot with *root:*
 
 
+### respond_a_record 
 
+* params : 
+  - OPTIONAL[root: <:symbol>] : 
+* goal : check if the return is a JSON Hash, could be chroot with *root:*
 
+### respond_with_collection
+* params :
+  -  size: Integer
+  -  OPTIONAL[root: <:symbol>] 
+* goal : check if the collection have the good size, could be chroot with *root:*
+  
+### respond_with  
+* params : 
+  - data: Object
+  - OPTIONAL[root: <:symbol>] 
+* goal : check if the return match the given object, could be chroot with root:
 
+### respond_with_status 
+* params : 
+  - code: Integer
+* goal : check if the HTTP response code is the good.
+
+
+## More 
+
+### Data dumper RestService#returned_data
+
+You could, for debug your tests and during dev, dump your data with 
+
+```ruby
+describe 'Test REST API' do
+    before :all do
+      $service = RestService::new :service => Application
+    end
+  
+    subject { $service }
+    context "GET /data" do
+      it { expect(subject.get('/data')).to be_correctly_sent }
+      it { subject.returned_data }
+    end
+end
+``` 
     
+It display the returned data of API. 
+
+###  Fixtures getter
+
+If you want to compare or inject data you could create fixture YAML files with :
+
+
+```ruby
+
+  describe 'Test REST API' do
+    before :all do
+      $service = RestService::new :service => Application
+      $mydata = get_file 'spec/fixtures/mydata.yml'
+    end
+  
+    subject { $service }
+    context "POST /data : test" do
+      it {  expect(subject.post('/data',$mydata.to_json)).to be_correctly_sent }
+    end
+
+
+end
+```
+
+### Statefullies helpers
+
+To be able to record ids of record, rack-rest-spec offer two helpers, to transit data from tests to tests.
+
+```ruby
+
+  describe 'Test REST API' do
+    before :all do
+      $service = RestService::new :service => Application
+      $mydata = get_file 'spec/fixtures/mydata.yml'
+    end
+  
+    subject { $service }
+    context "POST /data : test" do
+      it {  expect(subject.post('/data',$mydata.to_json)).to be_correctly_sent }
+      it { memorize id: subject.returned_data[:id] }
+    end
+
+    context "GET /data/<id> : test" do
+      it { expect(subject.get("/data#{retrieve(:id)}")).to be_correctly_sent }
+      end
+    end
+
+end
+```
+
 

data/Rakefile

@@ -1,54 +1,61 @@
-require "bundler/gem_tasks"
-require 'rubygems'
-require 'version'
-require 'rake/version_task'
-require 'rspec'
-require 'rake'
-require "rake/clean"
-require "rubygems/package_task"
-require "rdoc/task"
-require 'code_statistics'
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop//rake_task'
+
 require 'yard'
-require 'yard/rake/yardoc_task.rb'
-require "rake/tasklib"
-require "roodi"
-require "roodi_task"
+require 'yard/rake/yardoc_task'
 
+require 'code_statistics'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
+require 'version'
+require 'rake/version_task'
 Rake::VersionTask.new
 
-RoodiTask.new() do | t |
-t.patterns = %w(lib/**/*.rb)
-t.config = "ultragreen_roodi_coding_convention.yml"
-end
-
-
-CLEAN.include('*.tmp','*.old')
-CLOBBER.include('*.tmp', 'build/*','#*#')
-
-
-content = File::readlines(File.join(File.dirname(__FILE__), 'rack-rest-rspec.gemspec')).join
-spec = eval(content)
-
-RSpec::Core::RakeTask.new('spec')
-
 YARD::Rake::YardocTask.new do |t|
-  t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']
-  t.options += ['--title', "Gem Documentation"]
-  t.options += ['-o', "yardoc"]
+  t.files = ['lib/**/*.rb', '-', 'doc/**/*', 'spec/**/*_spec.rb']
+  t.options += ['-o', 'yardoc']
 end
 YARD::Config.load_plugin('yard-rspec')
 
 namespace :yardoc do
   task :clobber do
-    rm_r "yardoc" rescue nil
-    rm_r ".yardoc" rescue nil
+    begin
+      rm_r 'yardoc'
+    rescue StandardError
+      nil
+    end
+    begin
+      rm_r '.yardoc'
+    rescue StandardError
+      nil
+    end
+    begin
+      rm_r 'pkg'
+    rescue StandardError
+      nil
+    end
   end
 end
-task :clobber => "yardoc:clobber"
+task clobber: 'yardoc:clobber'
 
+desc 'Run CVE security audit over bundle'
+task :audit do
+  system('bundle audit')
+end
 
+desc 'Run dead line of code detection'
+task :debride do
+  system('debride -w .debride_whitelist .')
+end
 
+desc 'Run SBOM CycloneDX Xml format file'
+task :sbom do
+  system('cyclonedx-ruby -p .')
+end

data/VERSION

@@ -1 +1 @@
-0.0.4
+1.0.0