mock-twilio 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ab342d529e8d1886517cdffe112de027d4faa800e999f1761d70cacf91da958
-  data.tar.gz: 42f3e99d12fe4b0e88160d52437a32c8cf20786abaebb32a4ad084579a223d4f
+  metadata.gz: fbb843efbd1e8b54602d0463971c24a502b20b42ec9085530f624549190bee40
+  data.tar.gz: 40d24741f57296220aaa3ca36b21c2b5fd429a08c4669c2ce2cf0f636696889a
 SHA512:
-  metadata.gz: a74c263e59ca0f944ef427387e60c6ec1d9a30e0e02d0583b1993171f286f58e3b6178cf9eed13fa0db68c88e2071f4512e6d18cbace5d04120c51c7bbb24759
-  data.tar.gz: b1782b5d6da621259f3b3d0633623b1c9cfed90993ff613f73485bf169f22317da1396f73ca1f7102fa7456261a8d2752272ac6f44f10c2452cc9f669b2660cb
+  metadata.gz: 570376720a4f739d537bdb4285cfd8aaadea578d3d076089b849a8d7f66b603a0b0562a116c0fc9ecb6462ee64d8f8fdf3cb957d2c8a4a82575111354ba16670
+  data.tar.gz: 41dc6b8fcd7b6e2b58b85d81eb43e75defc1969a7c8a349ef4546a4a7c9114a35e4e9d85e3e4dc804b95ea7f9de827551a2a1724dd82e52eaa8d8d0ed712f9d4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [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,3 +8,5 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+gem "webmock"
+gem "pry"

data/README.md

@@ -5,16 +5,10 @@ This is a SchoolStatus implementation to mock twilio client to perform requests
 
 # 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'
-```
-
-To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
-
-```bash
-gem install mock-twilio
+gem "mock-twilio", "~> 0.2.0", git: "https://github.com/schoolstatus/mock-twilio.git"
 ```
 
 ## Requirements
@@ -31,7 +25,18 @@ OR
 - `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
@@ -42,6 +47,11 @@ 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.

data/lib/mock/twilio/client.rb

@@ -7,7 +7,7 @@ module Mock
     # client.messages.create(to: "+593978613041", body: "RB This is the ship that made the Kesssssel Run in fourteen parsecs?", from: "+13212855389")
     class Client
       attr_accessor :adapter
-      attr_reader :timeout, :last_response, :last_request
+      attr_reader :timeout, :last_response, :last_request, :proxy_addr, :proxy_port, :proxy_prot
 
       def initialize(proxy_prot = nil, proxy_addr = nil, proxy_port = nil, timeout: nil)
         @proxy_prot = proxy_prot || 'http'

data/lib/mock/twilio/decorator.rb

@@ -11,9 +11,15 @@ module Mock
       class << self
         def call(body, request)
           body = JSON.parse(body)
+
+          case body["status"]
+          when 400..600
+            return body
+          end
+
           schema = url_from(body, request)
-          # return body decorataor if needed
-          return ENDPOINTS[schema].decorate(body) if schema
+          # return body decorate if needed
+          return ENDPOINTS[schema].decorate(body, request) if schema
 
           body
         end

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

@@ -19,14 +19,16 @@ module Mock
             "uri"
           ].freeze
 
-          def decorate(body)
+          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
 
@@ -37,6 +39,16 @@ module Mock
               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

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

@@ -5,7 +5,7 @@ module Mock
     module Schemas
       class MessagingV1
         class << self
-          def decorate(body)
+          def decorate(body, request)
             # Params for twilio pagination, needed for twilio-ruby serializers and absolute paths
             body["meta"]["key"] = "phone_numbers" if body["meta"]
             body["meta"]["page_size"] = 20 if body["meta"]

data/lib/mock/twilio/util/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Util
+      class Configuration
+        attr_accessor :host, :forwarded_host, :port, :proto
+
+        def host=(value)
+          @host = value
+        end
+
+        def forwarded_host=(value)
+          @forwarded_host = value
+        end
+
+        def port=(value)
+          @port = value
+        end
+
+        def proto=(value)
+          @proto = value
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/version.rb

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

data/lib/mock/twilio/webhook_client.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    class WebhooksClient
+      attr_accessor :adapter
+      attr_reader :timeout, :last_request
+
+      def initialize(timeout: nil)
+        @timeout = timeout
+        @adapter = Faraday.default_adapter
+      end
+
+      def _request(request)
+        @connection = Faraday.new(url: request.host + ":" + request.port.to_s, ssl: { verify: true }) do |f|
+          f.options.params_encoder = Faraday::FlatParamsEncoder
+          f.request :url_encoded
+          f.adapter @adapter
+          f.headers = request.headers
+          f.request(:authorization, :basic, request.auth[0], request.auth[1])
+
+          f.options.open_timeout = request.timeout || @timeout
+          f.options.timeout = request.timeout || @timeout
+        end
+
+        response = @connection.send(request.method.downcase.to_sym,
+                                    request.url,
+                                    request.method == "GET" ? request.params : request.data)
+
+        if response.body && !response.body.empty?
+          object = response.body
+        elsif response.status == 400
+          object = { message: "Bad request", code: 400 }.to_json
+        end
+
+        response
+      end
+
+      def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+        request = ::Twilio::Request.new(host, port, method, url, params, data, headers, auth, timeout)
+        _request(request)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Webhooks
+      class RestError < StandardError
+      end
+      class Base
+        DELAY = [0.5, 0.8]
+
+        def self.build_signature_for_request(request_url, params)
+          validator = ::Twilio::Security::RequestValidator.new(::Twilio.auth_token)
+          validator.build_signature_for(request_url, params)
+        end
+
+        def self.twilio_client
+          ::Twilio::REST::Client.new
+        end
+
+        def self.webhook_client
+          Mock::Twilio::WebhooksClient.new
+        end
+
+        def self.auth_twilio
+          [twilio_client.account_sid, twilio_client.auth_token]
+        end
+
+        def self.headers
+          {
+            'X-Forwarded-Proto': Mock::Twilio.proto,
+            'Host': Mock::Twilio.forwarded_host
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Webhooks
+      class Messages < Base
+        URL = "/api/v1/twilio_requests/webhook_message_updates"
+
+        def self.trigger(sid)
+          # Wait simulation from twilio
+          sleep DELAY.sample
+
+          request_url = Mock::Twilio.proto + "://" + Mock::Twilio.forwarded_host + URL
+
+          data = { :MessageSid=>sid, :MessageStatus=>"delivered" }
+
+          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
+      end
+    end
+  end
+end

data/lib/mock/twilio.rb

@@ -1,8 +1,15 @@
 # frozen_string_literal: true
 
+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/util/configuration"
 require_relative "twilio/client"
 require_relative "twilio/decorator"
 require_relative "twilio/response"
@@ -10,6 +17,18 @@ require_relative "twilio/version"
 
 module Mock
   module Twilio
-    class Error < StandardError; end
+    extend SingleForwardable
+
+    def_delegators :configuration, :host, :forwarded_host, :port, :proto
+
+    def self.configure(&block)
+      yield configuration
+    end
+
+    def self.configuration
+      @configuration ||= Util::Configuration.new
+    end
+
+    private_class_method :configuration
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mock-twilio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - SchoolStatus Platform Team
@@ -24,6 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This repository contains Mock::Twilio::Client for Twilio's API.
 email: 
 executables: []
@@ -42,7 +84,11 @@ files:
 - lib/mock/twilio/response.rb
 - lib/mock/twilio/schemas/api_2010.rb
 - lib/mock/twilio/schemas/messaging_v1.rb
+- lib/mock/twilio/util/configuration.rb
 - lib/mock/twilio/version.rb
+- lib/mock/twilio/webhook_client.rb
+- lib/mock/twilio/webhooks/base.rb
+- lib/mock/twilio/webhooks/messages.rb
 - sig/mock/twilio.rbs
 homepage: https://github.com/schoolstatus/mock-twilio
 licenses: