README.md in mock-twilio-0.1.0 vs README.md in mock-twilio-0.2.0

- old
+ new

@@ -3,22 +3,16 @@ This is a SchoolStatus implementation to mock twilio client to perform requests to [twilio-oai](https://github.com/twilio/twilio-oai) # Installation -To install using [Bundler][bundler] grab the latest stable version: +To install using bundler grab the latest stable version: ```ruby -gem 'mock-twilio', '~> 0.1.0' +gem "mock-twilio", "~> 0.2.0", git: "https://github.com/schoolstatus/mock-twilio.git" ``` -To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install: - -```bash -gem install mock-twilio -``` - ## Requirements - [Twilio OAI](https://github.com/twilio/twilio-oai) and [More Info](https://www.twilio.com/en-us/blog/introducing-twilios-openapi-specification-ga) OR @@ -29,18 +23,34 @@ - `proxy_address = twilio_mock_server` - `proxy_port = 4010` - `proxy_protocol = http` ## How to use +Initializer sample +```ruby +Mock::Twilio.configure do |config| + config.host = "http://shunkan-ido-service" + config.forwarded_host = "shunkan-ido-service" + config.port = "3000" + config.proto = "http" +end +``` + +Example ```ruby export TWILIO_ACCOUNT_SID=ACFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF export TWILIO_API_KEY=SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX export TWILIO_API_SECRET=ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX mock_client = Mock::Twilio::Client.new client = Twilio::REST::Client.new(nil, nil, nil, nil, mock_client) client.messages.create(to: "+593978613041", body: "RB This is the ship that made the Kesssssel Run in fourteen parsecs?", from: "+13212855389") +``` + +## Run tests +```unix +rake test ``` ## Swagger - OpenApi Issues - Array and Boolean validations due open api formats, ie params as `status_callback_event`, `early_media`. Validations removed for them on json files.