rack-rest-rspec 0.0.4 → 1.0.0

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

@@ -1,2 +1,3 @@
-# encoding: UTF-8
-Dir[File.dirname(__FILE__) + '/*.rb'].each {|file| require file  unless File.basename(file) == 'init.rb'}
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/*.rb"].each { |file| require file unless File.basename(file) == 'init.rb' }

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

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'pstore'
 
 def memorize(options)
-
-  $store = PStore.new("/tmp/data.pstore")
+  $store = PStore.new('/tmp/data.pstore')
   $store.transaction do
-    options.each do |key,val|
+    options.each do |key, val|
       $store[key] = val
     end
     $store.commit
@@ -12,6 +13,6 @@ def memorize(options)
 end
 
 def retrieve(key)
-  $store = PStore.new("/tmp/data.pstore")
-  return $store.transaction { $store[key] }
+  $store = PStore.new('/tmp/data.pstore')
+  $store.transaction { $store[key] }
 end

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

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

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

@@ -1,29 +1,26 @@
-require 'forwardable'
+# frozen_string_literal: true
 
+require 'forwardable'
 
 class RestService
   extend Forwardable
-  
-  
-  attr_reader :path
-  attr_reader :service
-  attr_reader :browser
+
+  attr_reader :path, :service, :browser
 
   def initialize(params = {})
     defaults = {
-      :service => Sinatra::Base,
-      :path => '/'
+      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
 
-    def returned_data
-      return JSON::parse(@browser.last_response.body, symbolize_names: true)
-    end
+  def_delegators :@browser, :get, :post, :put, :delete
 
+  def returned_data
+    JSON.parse(@browser.last_response.body, symbolize_names: true)
+  end
 end

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 RSpec::Matchers.define :be_correctly_sent do
   match do |actual|
-    actual.class == Rack::MockResponse
+    actual.instance_of?(Rack::MockResponse)
   end
   description do
-    "be a valid HTTP verb request with a valid response return"
+    'be a valid HTTP verb request with a valid response return'
   end
   failure_message do |actual|
     "expected this HTTP verb request to return a valid response, \nneed : Rack::MockResponse \ngot  : #{actual.class}"

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

@@ -1,2 +1,3 @@
-# encoding: UTF-8
-Dir[File.dirname(__FILE__) + '/*.rb'].each {|file| require file  unless File.basename(file) == 'init.rb'}
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/*.rb"].each { |file| require file unless File.basename(file) == 'init.rb' }

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

@@ -1,14 +1,22 @@
-RSpec::Matchers.define :respond_a_collection_of_record do
+# frozen_string_literal: true
+
+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.instance_of?(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,22 @@
-RSpec::Matchers.define :respond_a_record do
+# frozen_string_literal: true
+
+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.instance_of?(Hash)
   end
   description do
-    "respond with a record (Hash)"
+    '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,24 @@
-RSpec::Matchers.define :respond_with_collection_size do |expected|
+# frozen_string_literal: true
+
+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

@@ -1,45 +1,43 @@
-def compare_array_of_hash expected, actual
-  if expected.size == actual.size then
-    res = true
-    actual.each_with_index do |item,index|
-      res = false unless item ==  expected[index]
-    end
-    return res
-  else
-    return false
-  end
-end
+# frozen_string_literal: true
 
-def prepare_array data
-  data = (data.class == Hash)? [data] : data
-  data.each do |ahash|
-    ahash.symbolize!
+def compare_array_of_hash(expected, actual)
+  return false unless expected.size == actual.size
+
+  res = true
+  actual.each_with_index do |item, index|
+    res = false unless item == expected[index]
   end
-  return data
+  res
 end
 
+def prepare_array(data)
+  data.instance_of?(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
-    if result.empty? then
-      false 
+    result = JSON.parse(actual.browser.last_response.body, symbolize_names: true)
+    result = result[options[:root]] unless options[:root].nil?
+    if result.empty?
+      false
     else
-      result = JSON::parse(result)
       result = prepare_array result
       expected = prepare_array expected
-      compare_array_of_hash expected,result
+      compare_array_of_hash expected, result
     end
   end
   description do
-    "respond with corresponding data"
+    '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,20 @@
-RSpec::Matchers.define :respond_with_status do |expected|
+# frozen_string_literal: true
+
+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

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'rspec'
 require 'rack/test'
 require 'rspec/expectations'
 
-require_relative 'lib/rest_service.rb'
-require_relative 'helpers/init.rb'
-require_relative 'matchers/init.rb' 
+require_relative 'lib/rest_service'
+require_relative 'helpers/init'
+require_relative 'matchers/init'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'version'
 module RackRestRspec
   is_versioned

data/rack-rest-rspec.gemspec

@@ -1,31 +1,42 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
-  spec.name          = "rack-rest-rspec"
+  spec.name          = 'rack-rest-rspec'
   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.authors       = ['Romain GEORGES']
+  spec.email         = ['romain@ultragreen.net']
+  spec.summary       = 'Rack-rest-rspec: RSpec Matchers for REST Rack webservice '
+  spec.description   = 'Rack-rest-rspec: RSpec Matchers for REST Rack webservice '
+  spec.homepage      = 'http://github.com/Ultragreen/rack-rest-rspec'
+  spec.license       = 'MIT'
 
-  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.required_ruby_version = Gem::Requirement.new('>= 3.2.3')
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  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"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
 
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
+  spec.add_development_dependency 'code_statistics', '~> 0.2.13'
+  spec.add_development_dependency 'cyclonedx-ruby', '~> 1.1'
+  spec.add_development_dependency 'debride', '~> 1.12'
+  spec.add_development_dependency 'diff-lcs', '~> 1.5.1'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.add_development_dependency 'rubocop', '~> 1.32'
+  spec.add_development_dependency 'sinatra', '~> 4.0'
+  spec.add_development_dependency 'yard', '~> 0.9.28'
+  spec.add_development_dependency 'yard-rspec', '~> 0.1'
+  spec.add_runtime_dependency 'rack-test', '~> 2.0'
+  spec.add_runtime_dependency 'version', '~> 1.1'
 end

data/samples/.rspec

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

data/samples/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'puma', '~> 6.4'
+gem 'rackup', '~> 2.1'
+gem 'sinatra', '~> 4.0.0'
+
+group :test, :development do
+  gem 'rack-rest-rspec', '~> 0.0.3'
+  gem 'rack-test', '~> 2.0.2'
+  gem 'rake', '~> 13.0'
+  gem 'rspec', '~> 3.10.0'
+end

data/samples/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+require './app'
+
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end

data/samples/app.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'sinatra'
+
+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

data/samples/config.ru

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require './app'
+
+run Application

data/samples/spec/api_spec.rb

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

data/samples/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'rack-rest-rspec/prepare'
+require_relative '../app'