NECMockServer

Project represents Ruby gem of simple Rack server designed for use as mock server of third part application in unit tests.

Installation

Add this line to your application's Gemfile:

gem 'nec_mock_server'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nec_mock_server

Usage

Example of usage for class NEC::MockServer::Server:

require 'nec_mock_server'

# Your sub app need to define all routes (UCs).
class SubAppRouter < NEC::MockServer::Router
  def route(parts, request_data)
    case parts[:resource]
      when "/test"
        ok("Get data was called on #{parts[:tid]}-#{parts[:awid]}")
      when "/returnRequestData"
        ok({data: request_data}, JSON_HEADER)
      when "/", ""
        home
      else
        not_found(parts[:resource])
    end
  end
end

app_config = {
    application_name: 'Sub App name',
    only_registered_awid: true # all request on un registered awids (without sys/initAppworkspace, or via app_config) will be rejected
    awids: {
      "00000000000000000000000000000000" => ["00000000000000000000000000000001"] # TID => [AWID, ...] 
    }
}

mock_server = NEC::MockServer::Server.new(SubAppRouter, app_config)
mock_server.run!(9001)

Example of usage class NEC::MockServerStarter:

require 'nec_mock_server'

# define absolute path to directory with run.rb of your sub app
sub_app_data_path = File.expand_path('../../mock_servers/sub_app', __FILE__)
sub_app_data = NEC::MockServerStarter.new(sub_app_data_path)
sub_app_data.run! # server start in new command line with IRB

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/MarekFiltes/nec_mock_server. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the NecMockServer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.