mock-twilio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3ab342d529e8d1886517cdffe112de027d4faa800e999f1761d70cacf91da958
+  data.tar.gz: 42f3e99d12fe4b0e88160d52437a32c8cf20786abaebb32a4ad084579a223d4f
+SHA512:
+  metadata.gz: a74c263e59ca0f944ef427387e60c6ec1d9a30e0e02d0583b1993171f286f58e3b6178cf9eed13fa0db68c88e2071f4512e6d18cbace5d04120c51c7bbb24759
+  data.tar.gz: b1782b5d6da621259f3b3d0633623b1c9cfed90993ff613f73485bf169f22317da1396f73ca1f7102fa7456261a8d2752272ac6f44f10c2452cc9f669b2660cb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2024-05-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mock-twilio.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Guillermo Quezada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+## Mock::Twilio::Client
+
+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:
+
+```ruby
+gem 'mock-twilio', '~> 0.1.0'
+```
+
+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
+
+- `docker compose up twilio_mock_server` [SS Twilio Mock Server](https://github.com/schoolstatus/twilio_mock_server)
+
+## Defaults Prism
+
+- `proxy_address = twilio_mock_server`
+- `proxy_port = 4010`
+- `proxy_protocol = http`
+
+## How to use
+
+```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")
+```
+
+## 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/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/mock/twilio/client.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    # 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")
+    class Client
+      attr_accessor :adapter
+      attr_reader :timeout, :last_response, :last_request
+
+      def initialize(proxy_prot = nil, proxy_addr = nil, proxy_port = nil, timeout: nil)
+        @proxy_prot = proxy_prot || 'http'
+        @proxy_addr = proxy_addr || 'twilio_mock_server'
+        @proxy_port = proxy_port || '4010'
+        @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])
+          if @proxy_addr
+            f.proxy = "#{@proxy_prot}://#{@proxy_addr}:#{@proxy_port}"
+          end
+
+          f.use Mock::Twilio::Middleware::Proxy
+
+          f.options.open_timeout = request.timeout || @timeout
+          f.options.timeout = request.timeout || @timeout
+        end
+
+        @last_request = request
+        @last_response = nil
+        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
+
+        twilio_response = Mock::Twilio::Response.new(response.status, object, request, headers: response.headers)
+        @last_response = twilio_response
+
+        twilio_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/decorator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    class Decorator
+      ENDPOINTS = {
+        api_2010: Mock::Twilio::Schemas::Api2010,
+        messaging_v1: Mock::Twilio::Schemas::MessagingV1,
+      }
+
+      class << self
+        def call(body, request)
+          body = JSON.parse(body)
+          schema = url_from(body, request)
+          # return body decorataor if needed
+          return ENDPOINTS[schema].decorate(body) if schema
+
+          body
+        end
+
+        def url_from(body, request)
+          url = request.url.split(request.host).last
+
+          case url
+          when %r{\/2010-04-01/Accounts/[A-Za-z0-9]+/}
+            :api_2010
+          when %r{\/v1/Services/[A-Za-z0-9]+/}
+            :messaging_v1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/middleware/proxy.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Mock
+  module Twilio
+    module Middleware
+      class Proxy < Faraday::Middleware
+        def initialize(app)
+          super(app)
+        end
+
+        def call(env)
+          env.url.host = env.request.proxy.host
+          env.url.port = env.request.proxy.port
+          env.url.scheme = env.request.proxy.scheme
+          super
+        end
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(proxy: Mock::Twilio::Middleware::Proxy)

data/lib/mock/twilio/response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    class Response
+      attr_accessor :status_code, :body, :headers
+
+      def initialize(status_code, body, request, headers: nil)
+        @status_code = status_code
+        body = '{}' if !body || body.empty?
+        @body = Mock::Twilio::Decorator.call(body, request)
+        @headers = !headers ? {} : headers.to_hash
+      end
+
+      def to_s
+        "[#{status_code}] #{body}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Schemas
+      class Api2010
+        class << self
+          PAGES_KEYS = [
+            "end",
+            "first_page_uri",
+            "next_page_uri",
+            "last_page_uri",
+            "page",
+            "page_size",
+            "previous_page_uri",
+            "total",
+            "num_pages",
+            "start",
+            "uri"
+          ].freeze
+
+          def decorate(body)
+            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"]
+
+            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
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    module Schemas
+      class MessagingV1
+        class << self
+          def decorate(body)
+            # 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"]
+            body["meta"]["first_page_url"] = "https://messaging.twilio.com/v1/Services/MGFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/PhoneNumbers?PageSize=20&Page=0" if body["meta"]
+            body["meta"]["previous_page_url"] = "https://messaging.twilio.com/v1/Services/MGFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/PhoneNumbers?PageSize=20&Page=0" if body["meta"]
+            body["meta"]["next_page_url"] = "https://messaging.twilio.com/v1/Services/MGFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/PhoneNumbers?PageSize=20&Page=1" if body["meta"]
+            body["meta"]["url"] = "https://messaging.twilio.com/v1/Services/MGFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF/PhoneNumbers?PageSize=20&Page=0" if body["meta"]
+            body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/twilio/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mock
+  module Twilio
+    VERSION = "0.1.0"
+  end
+end

data/lib/mock/twilio.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "twilio/middleware/proxy"
+require_relative "twilio/schemas/api_2010"
+require_relative "twilio/schemas/messaging_v1"
+require_relative "twilio/client"
+require_relative "twilio/decorator"
+require_relative "twilio/response"
+require_relative "twilio/version"
+
+module Mock
+  module Twilio
+    class Error < StandardError; end
+  end
+end

data/sig/mock/twilio.rbs

@@ -0,0 +1,6 @@
+module Mock
+  module Twilio
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: mock-twilio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SchoolStatus Platform Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-06-10 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: This repository contains Mock::Twilio::Client for Twilio's API.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mock/twilio.rb
+- lib/mock/twilio/client.rb
+- lib/mock/twilio/decorator.rb
+- lib/mock/twilio/middleware/proxy.rb
+- lib/mock/twilio/response.rb
+- lib/mock/twilio/schemas/api_2010.rb
+- lib/mock/twilio/schemas/messaging_v1.rb
+- lib/mock/twilio/version.rb
+- sig/mock/twilio.rbs
+homepage: https://github.com/schoolstatus/mock-twilio
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: This repository contains Mock::Twilio::Client for Twilio's API.
+test_files: []