rack-rest-rspec 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eb2d19e331be1cd12bce9ce623ed1844c181c7fcacb8960acb2c4e973dd2bd4
-  data.tar.gz: 3b508c8c0b42e6bf2e6f2f9d475fc97b0fd7209270d445ba7fb8ae7e53dcbfd4
+  metadata.gz: 991c3ce92453468607c170e5546f355d3ce1cec02c970651906599af34e3ec0e
+  data.tar.gz: 77955b805aed17ad1639496176821b9203dde097228b5aebaf237db9727c8947
 SHA512:
-  metadata.gz: 77d1fcb75c1082c6805bbb7b0d2985b5ffbb68d487af73014b75aad83feead049acf6e2bfe683f6c4ba5a1d63d90dfee0f66a81d345d59db0bb2b43ac13a280c
-  data.tar.gz: 94caf0509356b636482b841aca8e9b5a4ef1a06438480d6498b8feeeedc935880ecb7d79ab4f74484922edbd702c2b67b5aafb38993f267dfceabca947890fa7
+  metadata.gz: 5ba8ada8c6a9d413484b75b71fa368e9e9b59a09f1e903e1d8728a3a49a59f516054937e316b0f6d5948c155ef0cf4b304f55eeace61c479757a15c32497c880
+  data.tar.gz: b8ce3dad6fcac708eac0b5f0d50fc140dd5f6e98a4455c5b0e275a9d5a307740ec9f934f0da98297e80baf5f652a98abe8b6f52514e92741a1f07fe4826351a2

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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"

data/README.md

@@ -0,0 +1,78 @@
+# Rack REST RSpec 
+
+RSpec Matchers for REST Rack webservice
+
+
+Install it yourself as:
+
+    $ gem install rack-rest-rspec
+
+or
+
+    $ bundle add 'rack-rest-rspec'
+
+## Usage
+
+### Basic usage : install in your spec/spec_helper.rb or spec/prepare.rb 
+
+    require 'rack-rest-rspec/prepare'
+
+### 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
+
+
+
+    end
+
+
+## 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.
+
+
+
+
+
+    
+

data/Rakefile

@@ -1,5 +1,7 @@
 require "bundler/gem_tasks"
 require 'rubygems'
+require 'version'
+require 'rake/version_task'
 require 'rspec'
 require 'rake'
 require "rake/clean"
@@ -14,6 +16,10 @@ require "roodi"
 require "roodi_task"
 
 
+task default: :spec
+
+Rake::VersionTask.new
+
 RoodiTask.new() do | t |
 t.patterns = %w(lib/**/*.rb)
 t.config = "ultragreen_roodi_coding_convention.yml"
@@ -45,16 +51,4 @@ end
 task :clobber => "yardoc:clobber"
 
 
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
-
-Rake::RDocTask.new('rdoc') do |d|
-  d.rdoc_files.include('doc/**/*','bin/*')
-  d.title = 'Dorsal : Yard'
-  d.options << '--line-numbers' << '--diagram' << '-SHN'
-end
-
-task :default => [:gem]
 

data/VERSION

@@ -1 +1 @@
-0.0.1a
+0.0.3

data/lib/rack-rest-rspec/helpers/memorizer.rb

@@ -0,0 +1,17 @@
+require 'pstore'
+
+def memorize(options)
+
+  $store = PStore.new("/tmp/data.pstore")
+  $store.transaction do
+    options.each do |key,val|
+      $store[key] = val
+    end
+    $store.commit
+  end
+end
+
+def retrieve(key)
+  $store = PStore.new("/tmp/data.pstore")
+  return $store.transaction { $store[key] }
+end

data/lib/rack-rest-rspec/helpers/yml.rb

@@ -0,0 +1,5 @@
+require 'yaml'
+
+def get_file(file)
+  return YAML.load(File::readlines(file).join)
+end

data/lib/rack-rest-rspec/lib/rest_service.rb

@@ -0,0 +1,25 @@
+require 'forwardable'
+
+
+class RestService
+  extend Forwardable
+  
+  
+  attr_reader :path
+  attr_reader :service
+  attr_reader :browser
+
+  def initialize(params = {})
+    defaults = {
+      :service => Sinatra::Base,
+      :path => '/'
+    }
+    defaults.merge! params
+    @service = defaults[:service]
+    @path = defaults[:path]
+    @browser = Rack::Test::Session.new(Rack::MockSession.new(@service))
+  end
+  
+    def_delegators :@browser, :get, :post, :put, :delete
+
+end

data/lib/rack-rest-rspec/prepare.rb

@@ -2,6 +2,6 @@ require 'rspec'
 require 'rack/test'
 require 'rspec/expectations'
 
-require_relative 'lib/restcrudservice.rb'
+require_relative 'lib/rest_service.rb'
 require_relative 'helpers/init.rb'
 require_relative 'matchers/init.rb' 

data/rack-rest-rspec.gemspec

@@ -5,27 +5,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rack-rest-rspec"
-  spec.version       = "0.0.1"
+  spec.version       = `cat VERSION`
   spec.authors       = ["Romain GEORGES"]
   spec.email         = ["romain@ultragreen.net"]
   spec.summary       = %q{Rack-rest-rspec: RSpec Matchers for REST Rack webservice }
   spec.description   = %q{Rack-rest-rspec: RSpec Matchers for REST Rack webservice }
   spec.homepage      = "http://github.com/Ultragreen/rack-rest-rspec"
   spec.license       = "BSD-2"
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
-  spec.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.2'
-  spec.add_development_dependency 'rdoc', '~> 4.0', '>= 4.0.1'
-  spec.add_development_dependency 'roodi', '~> 3.1', '>= 3.1.1'
-  spec.add_development_dependency 'code_statistics', '~> 0.2', '>= 0.2.13'
-  spec.add_development_dependency 'yard-rspec', '~> 0.1'
-  spec.add_runtime_dependency "rack-test", "~> 0.6", ">= 0.6.3"	
+  spec.add_development_dependency "roodi", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "code_statistics", "~> 0.2.13"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "yard", "~> 0.9.28"
+  spec.add_development_dependency "yard-rspec", "~> 0.1"
+  
+  spec.add_runtime_dependency "rack-test", "~> 2.0"
 
 
 end

metadata

@@ -1,143 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rack-rest-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Romain GEORGES
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: roodi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-- !ruby/object:Gem::Dependency
-  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7.2
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7.2
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: code_statistics
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 0.2.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: 0.2.13
 - !ruby/object:Gem::Dependency
-  name: roodi
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: code_statistics
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.9.28
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.2.13
+        version: 0.9.28
 - !ruby/object:Gem::Dependency
   name: yard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -158,20 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: '2.0'
 description: 'Rack-rest-rspec: RSpec Matchers for REST Rack webservice '
 email:
 - romain@ultragreen.net
@@ -179,11 +115,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- README.md
 - Rakefile
 - VERSION
-- lib/rack-rest-rspec/helpers/hash.rb
 - lib/rack-rest-rspec/helpers/init.rb
-- lib/rack-rest-rspec/lib/restcrudservice.rb
+- lib/rack-rest-rspec/helpers/memorizer.rb
+- lib/rack-rest-rspec/helpers/yml.rb
+- lib/rack-rest-rspec/lib/rest_service.rb
 - lib/rack-rest-rspec/matchers/be_correctly_sent.rb
 - lib/rack-rest-rspec/matchers/init.rb
 - lib/rack-rest-rspec/matchers/respond_a_collection_of_record.rb
@@ -199,7 +138,7 @@ homepage: http://github.com/Ultragreen/rack-rest-rspec
 licenses:
 - BSD-2
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: 'Rack-rest-rspec: RSpec Matchers for REST Rack webservice'
 test_files: []

data/lib/rack-rest-rspec/helpers/hash.rb

@@ -1,14 +0,0 @@
-class Hash
-  def symbolize! 
-    self.keys.each do |key|
-      self[key.to_sym] = self.delete(key)
-    end
-  end
-  
-  def stringify!
-    self.keys.each do |key|
-      self[key.to_s] = self.delete(key)
-    end
-    return ahash
-  end
-end

data/lib/rack-rest-rspec/lib/restcrudservice.rb

@@ -1,45 +0,0 @@
-class RestCRUDService
-
-  attr_reader :path
-  attr_reader :object 
-  attr_reader :browser
-
-  def initialize(params = {})
-    defaults = {
-      :path => '/api/', 
-      :object => '', 
-      :browser => Rack::Test::Session.new(Rack::MockSession.new(Sinatra::Application))
-    }
-    defaults.merge! params
-    @path = defaults[:path]
-    @object = defaults[:object]
-    @browser = defaults[:browser]
-  end
-
-  def url 
-    return "#{@path}/#{@object}"
-  end  
-
-  def create_record _data
-    return @browser.post self.url, _data
-  end
-
-  def retrieve_all_records
-    return @browser.get self.url
-  end  
-
-  def retrieve_record _nb
-    return @browser.get "#{self.url}/#{_nb}" 
-  end
-
-
-  def update_record _nb,_data
-    return @browser.put "#{self.url}/#{_nb}", _data
-  end
-
-
-  def destroy_record _nb
-    return @browser.delete "#{self.url}/#{_nb}"
-  end
-
-end