mock-twilio 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbb843efbd1e8b54602d0463971c24a502b20b42ec9085530f624549190bee40
-  data.tar.gz: 40d24741f57296220aaa3ca36b21c2b5fd429a08c4669c2ce2cf0f636696889a
+  metadata.gz: 2832d75e6a41828ad36e39908bc9316a8d851ced711843a9ec3142e46ac65a04
+  data.tar.gz: d20f52b78ef3d357e1210100b874ab08e35429993ee3c7499077267e40f25733
 SHA512:
-  metadata.gz: 570376720a4f739d537bdb4285cfd8aaadea578d3d076089b849a8d7f66b603a0b0562a116c0fc9ecb6462ee64d8f8fdf3cb957d2c8a4a82575111354ba16670
-  data.tar.gz: 41dc6b8fcd7b6e2b58b85d81eb43e75defc1969a7c8a349ef4546a4a7c9114a35e4e9d85e3e4dc804b95ea7f9de827551a2a1724dd82e52eaa8d8d0ed712f9d4
+  metadata.gz: 73a12decb37e2c63b6ab66d2d74fa49d9a281bd8a4391ed321a44f4dfb83ae81946a80e1d26f18903185e5393267714184bab959d8b073dd52d2dd8196aed0d1
+  data.tar.gz: cbdabf698e265893034d10ff001d7ae01ca035e8da18af469b1fbb9c399425e509bc3d49be40c6cb72b418ea86dc53f2336cc8cc75dce4cc6ecc2e262912a84c

data/CHANGELOG.md

@@ -1,8 +1,12 @@
+## [0.3.0] - 2024-06-24
+- Support Calls service
+- Support Conferences service
+- Support Webhooks CallStatusUpdates, Conferences and Calls
+
 ## [0.2.0] - 2024-06-09
 - Support MessageSid SMS and MMS
 - Support Webhooks::Messages SMS and MMS
 
-- Initial release
 ## [0.1.0] - 2024-05-29
 
 - Initial release

data/Gemfile

@@ -8,5 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+gem 'simplecov', require: false, group: :test
 gem "webmock"
 gem "pry"

data/README.md

@@ -1,4 +1,6 @@
 ## Mock::Twilio::Client
+[![Gem Version](https://badge.fury.io/rb/mock-twilio.svg)](https://badge.fury.io/rb/mock-twilio)
+![mock-twilio](https://github.com/schoolstatus/mock-twilio/actions/workflows/ruby.yml/badge.svg)
 
 This is a SchoolStatus implementation to mock twilio client to perform requests to  [twilio-oai](https://github.com/twilio/twilio-oai)
 
@@ -8,7 +10,7 @@ This is a SchoolStatus implementation to mock twilio client to perform requests
 To install using bundler grab the latest stable version:
 
 ```ruby
-gem "mock-twilio", "~> 0.2.0", git: "https://github.com/schoolstatus/mock-twilio.git"
+gem install mock-twilio
 ```
 
 ## Requirements

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
 end
 
 task default: :test

data/lib/mock/twilio/decorator.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative "schemas/api_2010"
+require_relative "schemas/messaging_v1"
+
 module Mock
   module Twilio
     class Decorator
@@ -19,7 +22,7 @@ module Mock
 
           schema = url_from(body, request)
           # return body decorate if needed
-          return ENDPOINTS[schema].decorate(body, request) if schema
+          return ENDPOINTS[schema].for(body, request) if schema
 
           body
         end

data/lib/mock/twilio/decorators/api_2010/calls.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Decorators
+      module Api2010
+        class Calls
+          class << self
+            def decorate(body, request)
+              body["date_updated"] = Time.current.rfc2822 if body["date_updated"]
+              body["date_sent"] = Time.current.rfc2822 if body["date_sent"]
+              body["date_created"] = Time.current.rfc2822 if body["date_created"]
+              body["start_time"] = Time.current.rfc2822 if body["start_time"]
+              body["end_time"] = Time.current.rfc2822 if body["end_time"]
+
+              call_sid(body, request) if body["sid"]
+              phone_number_sid(body, request) if body["phone_number_sid"]
+              body["direction"] = "outbound-api" if body["direction"]
+              body["api_version"] = "2010-04-01" if body["api_version"]
+              body["to"] = request.data['To'] if body["to"]
+              body["from"] = request.data['From'] if body["from"]
+
+              body
+            end
+
+            def call_sid(body, request)
+              prefix = "CA"
+              sid = prefix + SecureRandom.hex(16)
+              scheduler = Rufus::Scheduler.new
+              scheduler.in '2s' do
+                conference_uuid = request.data["Url"].split("conference_uuid=").last
+                response = Mock::Twilio::Webhooks::CallStatusUpdates.trigger(sid, conference_uuid)
+
+                conference_response = if response.status == 200
+                                        twiMl_xml = Nokogiri::XML response.body
+                                        friendly_name = twiMl_xml.at_xpath('//Dial').at_xpath('//Conference').children.text
+                                        Mock::Twilio::Webhooks::Conferences.trigger(friendly_name)
+                                      end
+
+                Mock::Twilio::Webhooks::Calls.trigger(sid) if conference_response.status == 200
+              end
+              body["sid"] = sid
+            end
+
+            def phone_number_sid(body, request)
+              prefix = "PN"
+              sid = prefix + SecureRandom.hex(16)
+              body["phone_number_sid"] = sid
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/decorators/api_2010/conferences_participants_create.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Decorators
+      module Api2010
+        class ConferencesParticipantsCreate
+          class << self
+            def decorate(body, request)
+              body["date_updated"] = Time.current.rfc2822 if body["date_updated"]
+              body["date_created"] = Time.current.rfc2822 if body["date_created"]
+              body["account_sid"] = ::Twilio.account_sid if body["account_sid"]
+              body["label"] = "Mock Customer" if body["label"]
+              body["status"] = "initiated" if body["status"]
+
+              parse_call_sid(body, request) if body["call_sid"]
+              parse_conference_sid(body, request) if body["conference_sid"]
+
+              body
+            end
+
+            def parse_call_sid(body, request)
+              prefix = "CA"
+              call_sid = prefix + SecureRandom.hex(16)
+              body["call_sid"] = call_sid
+            end
+
+            def parse_conference_sid(body, request)
+              uri = URI(request.url)
+              conference_sid = uri.path.split('/')[5]
+              body["conference_sid"] = conference_sid
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/decorators/api_2010/conferences_participants_update.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Decorators
+      module Api2010
+        class ConferencesParticipantsUpdate
+          class << self
+            def decorate(body, request)
+              body["date_updated"] = Time.current.rfc2822 if body["date_updated"]
+              body["date_created"] = Time.current.rfc2822 if body["date_created"]
+              body["account_sid"] = ::Twilio.account_sid if body["account_sid"]
+              body["label"] = "Mock Customer" if body["label"]
+              body["status"] = "complete" if body["status"]
+
+              parse_call_sid(body, request) if body["call_sid"]
+              parse_conference_sid(body, request) if body["conference_sid"]
+
+              body
+            end
+
+            def parse_call_sid(body, request)
+              uri = URI(request.url)
+              call_sid = uri.path.split('/')[7].split('.').first
+              body["call_sid"] = call_sid
+            end
+
+            def parse_conference_sid(body, request)
+              uri = URI(request.url)
+              conference_sid = uri.path.split('/')[5]
+              body["conference_sid"] = conference_sid
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/decorators/api_2010/messages.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Decorators
+      module Api2010
+        class Messages
+          class << self
+            def decorate(body, request)
+              body["date_updated"] = Time.current.rfc2822 if body["date_updated"]
+              body["date_sent"] = Time.current.rfc2822 if body["date_sent"]
+              body["date_created"] = Time.current.rfc2822 if body["date_created"]
+              body["start_time"] = Time.current.rfc2822 if body["start_time"]
+              body["end_time"] = Time.current.rfc2822 if body["end_time"]
+
+              message_sid(body, request) if body["sid"]
+              pagination(body) if body["available_phone_numbers"]
+
+              body
+            end
+
+            def pagination(body)
+              # Params returned in mock_server but not on real twilio request for the moment.
+              # Not needed for us now.
+              PAGES_KEYS.each do |key|
+                body.delete(key) if body[key]
+              end
+            end
+
+            def message_sid(body, request)
+              prefix = request.data["MediaUrl"] ? "MM" : "SM"
+              sid = prefix + SecureRandom.hex(16)
+              scheduler = Rufus::Scheduler.new
+              scheduler.in '2s' do
+                Mock::Twilio::Webhooks::Messages.trigger(sid)
+              end
+              body["sid"] = sid
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/schemas/api_2010.rb

@@ -1,10 +1,22 @@
 # frozen_string_literal: true
 
+require_relative "../decorators/api_2010/messages"
+require_relative "../decorators/api_2010/calls"
+require_relative "../decorators/api_2010/conferences_participants_update"
+require_relative "../decorators/api_2010/conferences_participants_create"
+
 module Mock
   module Twilio
     module Schemas
       class Api2010
         class << self
+          RESOURCES = {
+            messages: Mock::Twilio::Decorators::Api2010::Messages,
+            calls: Mock::Twilio::Decorators::Api2010::Calls,
+            conferences_participants_update: Mock::Twilio::Decorators::Api2010::ConferencesParticipantsUpdate,
+            conferences_participants_create: Mock::Twilio::Decorators::Api2010::ConferencesParticipantsCreate,
+          }
+
           PAGES_KEYS = [
             "end",
             "first_page_uri",
@@ -19,35 +31,19 @@ module Mock
             "uri"
           ].freeze
 
-          def decorate(body, request)
-            body["date_updated"] = Time.current.rfc2822 if body["date_updated"]
-            body["date_sent"] = Time.current.rfc2822 if body["date_sent"]
-            body["date_created"] = Time.current.rfc2822 if body["date_created"]
-            body["start_time"] = Time.current.rfc2822 if body["start_time"]
-            body["end_time"] = Time.current.rfc2822 if body["end_time"]
-
-            message_sid(body, request) if body["sid"]
-            pagination(body) if body["available_phone_numbers"]
-
-            body
-          end
-
-          def pagination(body)
-            # Params returned in mock_server but not on real twilio request for the moment.
-            # Not needed for us now.
-            PAGES_KEYS.each do |key|
-              body.delete(key) if body[key]
-            end
-          end
+          def for(body, request)
+            url = request.url.split(request.host).last
 
-          def message_sid(body, request)
-            prefix = request.data["MediaUrl"] ? "MM" : "SM"
-            sid = prefix + SecureRandom.hex(16)
-            scheduler = Rufus::Scheduler.new
-            scheduler.in '2s' do
-              Mock::Twilio::Webhooks::Messages.trigger(sid)
+            case url
+            when %r{\/2010-04-01/Accounts/[A-Za-z0-9]+/Messages.json}
+              RESOURCES[:messages].decorate(body, request)
+            when %r{\/2010-04-01/Accounts/[A-Za-z0-9]+/Calls.json}
+              RESOURCES[:calls].decorate(body, request)
+            when %r{\/2010-04-01/Accounts/[A-Za-z0-9]+/Conferences/[A-Za-z0-9]+/Participants/[A-Za-z0-9]+.json}
+              RESOURCES[:conferences_participants_update].decorate(body, request)
+            when %r{\/2010-04-01/Accounts/[A-Za-z0-9]+/Conferences/[A-Za-z0-9]+/Participants.json}
+              RESOURCES[:conferences_participants_create].decorate(body, request)
             end
-            body["sid"] = sid
           end
         end
       end

data/lib/mock/twilio/version.rb

@@ -2,6 +2,6 @@
 
 module Mock
   module Twilio
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/mock/twilio/webhooks/call_status_updates.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Webhooks
+      class CallStatusUpdates < Base
+        URL = "/api/v1/twilio_calls/voice_responses"
+
+        def self.trigger(sid, conference_uuid)
+          # Wait simulation from twilio
+          sleep DELAY.sample
+
+          request_url = Mock::Twilio.proto + "://" + Mock::Twilio.forwarded_host + URL
+
+          data = call_status_updates_data(sid, conference_uuid)
+
+          signature = build_signature_for_request(request_url, data)
+
+          response = webhook_client.request(Mock::Twilio.host,
+                                            Mock::Twilio.port,
+                                            'POST',
+                                            URL,
+                                            nil,
+                                            data,
+                                            headers.merge!({ 'X-Twilio-Signature': signature }),
+                                            auth_twilio,
+                                            nil)
+          case response.status
+          when 200..204
+            response
+          when 400..600
+            raise Webhooks::RestError, response.body
+          end
+        end
+
+        def self.call_status_updates_data(sid, conference_uuid)
+          {
+            :AccountSid=> twilio_client.account_sid,
+            :ApiVersion=>	"2010-04-01",
+            :CallbackSource=>	"call-progress-events",
+            :CallDuration=>	"0",
+            :Called=>	"+18222222222",
+            :CalledCity=>	"TAMPA",
+            :CalledCountry=> "US",
+            :CalledState=> "FL",
+            :CalledZip=> "33605",
+            :Caller=>	"+18111111111",
+            :CallerCity=> "no value",
+            :CallerCountry=> "US",
+            :CallerState=> "CA",
+            :CallerZip=> "no value",
+            :CallSid=> sid,
+            :CallStatus=> "in-progress",
+            :Direction=> "outbound-api",
+            :Duration=> "0",
+            :From=>	"+18111111111",
+            :FromCity=> "no value",
+            :FromCountry=> "US",
+            :FromState=> "CA",
+            :FromZip=> "no value",
+            :SequenceNumber=> "2",
+            :SipResponseCode=> "487",
+            :Timestamp=> "2024-06-17 16:49:31 UTC",
+            :To=>	"+18222222222",
+            :ToCity=> "TAMPA",
+            :ToCountry=> "US",
+            :ToState=> "FL",
+            :ToZip=> "33605",
+            :StirStatus=> "B",
+            :StirVerstat=> "TN-Validation-Passed-B",
+            :AnsweredBy=> "unknown",
+            :conference_uuid=> conference_uuid
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/webhooks/calls.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Webhooks
+      class Calls < Base
+        URL = "/api/v1/twilio_calls/participant_status_changes"
+
+        def self.trigger(sid)
+          # Wait simulation from twilio
+          sleep DELAY.sample
+
+          request_url = Mock::Twilio.proto + "://" + Mock::Twilio.forwarded_host + URL
+
+          data = call_data(sid)
+
+          signature = build_signature_for_request(request_url, data)
+
+          response = webhook_client.request(Mock::Twilio.host,
+                                            Mock::Twilio.port,
+                                            'POST',
+                                            URL,
+                                            nil,
+                                            data,
+                                            headers.merge!({ 'X-Twilio-Signature': signature }),
+                                            auth_twilio,
+                                            nil)
+          case response.status
+          when 200..204
+            response
+          when 400..600
+            raise Webhooks::RestError, response.body
+          end
+        end
+
+        def self.call_data(sid)
+          {
+            :AccountSid=> twilio_client.account_sid,
+            :ApiVersion=>	"2010-04-01",
+            :CallbackSource=>	"call-progress-events",
+            :CallDuration=>	"0",
+            :Called=>	"+18222222222",
+            :CalledCity=>	"TAMPA",
+            :CalledCountry=> "US",
+            :CalledState=> "FL",
+            :CalledZip=> "33605",
+            :Caller=>	"+18111111111",
+            :CallerCity=> "no value",
+            :CallerCountry=> "US",
+            :CallerState=> "CA",
+            :CallerZip=> "no value",
+            :CallSid=> sid,
+            :CallStatus=> "in-progress",
+            :Direction=> "outbound-api",
+            :Duration=> "0",
+            :From=>	"+18111111111",
+            :FromCity=> "no value",
+            :FromCountry=> "US",
+            :FromState=> "CA",
+            :FromZip=> "no value",
+            :SequenceNumber=> "2",
+            :SipResponseCode=> "487",
+            :Timestamp=> "2024-06-17 16:49:31 UTC",
+            :To=>	"+18222222222",
+            :ToCity=> "TAMPA",
+            :ToCountry=> "US",
+            :ToState=> "FL",
+            :ToZip=> "33605"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/webhooks/conferences.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Webhooks
+      class Conferences < Base
+        URL = "/api/v1/twilio_calls/conference_status_changes"
+
+        def self.trigger(friendly_name)
+          # Wait simulation from twilio
+          sleep DELAY.sample
+
+          request_url = Mock::Twilio.proto + "://" + Mock::Twilio.forwarded_host + URL
+
+          data = conference_data(friendly_name)
+
+          signature = build_signature_for_request(request_url, data)
+
+          response = webhook_client.request(Mock::Twilio.host,
+                                            Mock::Twilio.port,
+                                            'POST',
+                                            URL,
+                                            nil,
+                                            data,
+                                            headers.merge!({ 'X-Twilio-Signature': signature }),
+                                            auth_twilio,
+                                            nil)
+
+          case response.status
+          when 200..204
+            response
+          when 400..600
+            raise Webhooks::RestError, response.body
+          end
+        end
+
+        def self.conference_data(friendly_name)
+          prefix = "CF"
+          sid = prefix + SecureRandom.hex(16)
+          {
+           :FriendlyName=> friendly_name,
+           :SequenceNumber=> "6",
+           :ConferenceSid=> sid,
+           :StatusCallbackEvent=> "conference-start",
+           :Timestamp=> "2024-06-17 16:49:31 UTC",
+           :AccountSid=> twilio_client.account_sid,
+           :Reason=> "Participant from mock twilio"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio.rb

@@ -4,11 +4,12 @@ require "rufus-scheduler"
 require "active_support"
 require "active_support/core_ext/time"
 require_relative "twilio/middleware/proxy"
-require_relative "twilio/schemas/api_2010"
-require_relative "twilio/schemas/messaging_v1"
 require_relative "twilio/webhook_client"
 require_relative "twilio/webhooks/base"
 require_relative "twilio/webhooks/messages"
+require_relative "twilio/webhooks/calls"
+require_relative "twilio/webhooks/call_status_updates"
+require_relative "twilio/webhooks/conferences"
 require_relative "twilio/util/configuration"
 require_relative "twilio/client"
 require_relative "twilio/decorator"

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: mock-twilio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - SchoolStatus Platform Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-10 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: 2.9.1
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.9.1
 - !ruby/object:Gem::Dependency
   name: twilio-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.7.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.1.3.4
 description: This repository contains Mock::Twilio::Client for Twilio's API.
 email: 
 executables: []
@@ -80,6 +80,10 @@ files:
 - lib/mock/twilio.rb
 - lib/mock/twilio/client.rb
 - lib/mock/twilio/decorator.rb
+- lib/mock/twilio/decorators/api_2010/calls.rb
+- lib/mock/twilio/decorators/api_2010/conferences_participants_create.rb
+- lib/mock/twilio/decorators/api_2010/conferences_participants_update.rb
+- lib/mock/twilio/decorators/api_2010/messages.rb
 - lib/mock/twilio/middleware/proxy.rb
 - lib/mock/twilio/response.rb
 - lib/mock/twilio/schemas/api_2010.rb
@@ -88,6 +92,9 @@ files:
 - lib/mock/twilio/version.rb
 - lib/mock/twilio/webhook_client.rb
 - lib/mock/twilio/webhooks/base.rb
+- lib/mock/twilio/webhooks/call_status_updates.rb
+- lib/mock/twilio/webhooks/calls.rb
+- lib/mock/twilio/webhooks/conferences.rb
 - lib/mock/twilio/webhooks/messages.rb
 - sig/mock/twilio.rbs
 homepage: https://github.com/schoolstatus/mock-twilio
@@ -95,8 +102,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/schoolstatus/mock-twilio
-  source_code_uri: https://github.com/schoolstatus/mock-twilio.
-  changelog_uri: https://github.com/schoolstatus/mock-twilio/CHANGELOG.md
+  source_code_uri: https://github.com/schoolstatus/mock-twilio
+  changelog_uri: https://github.com/schoolstatus/mock-twilio/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.12
 signing_key: 
 specification_version: 4
 summary: This repository contains Mock::Twilio::Client for Twilio's API.