mock-twilio

Mock::Twilio::Client

This is a SchoolStatus implementation to mock twilio client to perform requests to twilio-oai

Installation

To install using bundler grab the latest stable version:

gem install mock-twilio

Requirements

• Twilio OAI and More Info

OR

• docker compose up twilio_mock_server SS Twilio Mock Server

Defaults Prism

• proxy_address = twilio_mock_server
• proxy_port = 4010
• proxy_protocol = http

Features Support

Support	Mock::Twilio::Client
:white_check_mark:	client.messages.create(to: "[phone]", body: "Testing SMS", from: "[phone]")
:white_check_mark:	client.messaging.v1.services("MG"+"F"*32).phone_numbers.create(phone_number_sid: @phone_number_sid)
:white_check_mark:	client.available_phone_numbers('US').local.list(limit: 20)
:white_check_mark:	client.incoming_phone_numbers.create(phone_number: "[phone]", voice_url: "#{BASE_URL}/api/v1/twilio_calls/incoming", sms_url: "#{BASE_URL}/api/v1/twilio_requests/inbound")
:white_check_mark:	client.incoming_phone_numbers.update(sms_application_sid: "AP"+"F"*32, voice_application_sid: "AP"+"F"*32)
:white_check_mark:	client.lookups.v2.phone_numbers("[phone]").fetch(fields: :line_type_intelligence)
:white_check_mark:	client.calls.create(url: '<http://demo.twilio.com/docs/voice.xml>', to: '[phone]', from: '[phone]', status_callback: '<https://myapp.com/events>', status_callback_event: ['ringing'], status_callback_method: 'POST')
:white_check_mark:	client.conferences("CF"+("F")*32).participants.create(label: 'customer', early_media: true, beep: 'onEnter', status_callback: '<https://myapp.com/events>', status_callback_event: ['ringing'], record: true, from: '[phone]', to: '[phone]')
:white_check_mark:	client.trusthub.v1.customer_profiles.create(**twilio_attributes)
:white_check_mark:	client.trusthub.v1.customer_profiles(customer_profile_sid).customer_profiles_entity_assignments.create(object_sid:)
:white_check_mark:	client.trusthub.v1.customer_profiles("BU"+"F"*32).customer_profiles_channel_endpoint_assignment.list(limit: 20)
:white_check_mark:	client.trusthub.v1.customer_profiles("BU"+"F"*32).customer_profiles_channel_endpoint_assignment("RA"+"F"*32).delete
:white_check_mark:	client.trusthub.v1.trust_products("BU"+"F"*32).trust_products_channel_endpoint_assignment.list(limit: 20)
:white_check_mark:	client.trusthub.v1.trust_products("BU"+"F"*32).trust_products_channel_endpoint_assignment("RA"+"F"*32).delete
:white_check_mark:	client.trusthub.v1.end_users.create(**twilio_parameters)
:white_check_mark:	client.trusthub.v1.supporting_documents.create(**twilio_parameters)
:white_check_mark:	client.addresses.create(**twilio_parameters)
:white_check_mark:	client.trusthub.v1.customer_profiles.create(**twilio_attributes)
:white_check_mark:	client.trusthub.v1.customer_profiles(customer_profile.sid).customer_profiles_evaluations.create(policy_sid:)

Trigger resources updates

Mock::Twilio::Webhooks	Support
Webhooks::Messages	:white_check_mark:
Webhooks::InboundMessages	:white_check_mark:
Webhooks::Calls	:white_check_mark:
Webhooks::CallStatusUpdates	:white_check_mark:
Webhooks::Voicemail	:white_check_mark:
Webhooks::Conferences	:white_check_mark:
Webhooks::CustomerProfiles	:white_check_mark:
Webhooks::Brands	:white_check_mark:

How to use

Initializer sample

# Local Docker/Host
Mock::Twilio.configure do |config|
  config.host = "http://shunkan-ido-service:3000"
  config.forwarded_host = "shunkan-ido-service:3000"
  config.port = "3000"
  config.proto = "http"
  # optional https://www.twilio.com/docs/messaging/api/message-resource#request-body-parameters
  # Use webhook_message_status_url as the Integration Send webhook from Messaging Service.
  # If you include status_callback parameter with the messaging_service_sid,
  # Twilio uses status_callback URL instead of the Status Callback URL(webhook_message_status_url) of the Messaging Service.
  # config.webhook_message_status_url = "http://shunkan_ido:3000/api/v1/twilio_requests/webhook_message_updates"
end

# Real http(s) url
Mock::Twilio.configure do |config|
  config.host = "https://my-server"
  config.forwarded_host = "my-server"
  config.port = "443"
  config.proto = "https"
  # optional https://www.twilio.com/docs/messaging/api/message-resource#request-body-parameters
  # Use webhook_message_status_url as the Integration Send webhook from Messaging Service.
  # If you include status_callback parameter with the messaging_service_sid,
  # Twilio uses status_callback URL instead of the Status Callback URL(webhook_message_status_url) of the Messaging Service.
  # config.webhook_message_status_url = "https://my-server/api/v1/twilio_requests/webhook_message_updates"
end

Example

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: "[phone]", body: "RB This is the ship that made the Kesssssel Run in fourteen parsecs?", from: "[phone]")

Run tests

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.