mock-bandwidth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b94456bdd96b95f64866379b3c9a06326b225d2e2f3e6bbce188e526348c506
+  data.tar.gz: 8dcff047c29e53d2b2b79e93ac3fb7a930443549144e883f5b259aa3bf2ac04f
+SHA512:
+  metadata.gz: 01e64367e88e041c8c213fb41b3ab73cd13fe8d5a5d41dcfb3a890ec236258355eee0726109d72c13d6d3da6b49d8ef634e201ed7ed3bfb559e4040ed6941eaa
+  data.tar.gz: f2846ce3140cbe36fdff50b602e025c558153a1e63326b09bdfcda5ff4f903ba5a4f028706d101612018f6c7996e99a56212704e110edf42e18c133c4d60af32

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0] - 2025-01-25
+
+- Add create message support

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 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,69 @@
+# Mock::Bandwidth
+
+This is a SchoolStatus implementation to mock Bandwidth to perform requests to [bandwidth-oai](https://docs.stoplight.io/docs/prism/83dbbd75532cf-http-mocking)
+
+
+# Installation
+
+To install using bundler grab the latest stable version:
+
+```ruby
+gem install mock-bandwidth
+```
+
+## Requirements
+- [Bandwidth-oai](https://docs.stoplight.io/docs/prism/83dbbd75532cf-http-mocking)
+
+## Defaults Prism
+
+- `proxy_address = bandwidth_mock_server`
+- `proxy_port = 4010`
+- `proxy_protocol = http`
+
+## Features Support
+
+| Support | Mock::Bandwidth   |
+| ------------- | ------------- |
+| :white_check_mark: | `Bandwidth::MessagesApi.new.create_message(account_id, body)`  |
+
+
+## How to use
+Initializer sample
+
+```ruby
+Bandwidth.configure do |config| # Configure Basic Auth
+  config.username = "username"
+  config.password = "password"
+  config.configure_faraday_connection do |connection|
+    connection.proxy = "http://mock-server.test"
+    connection.use Mock::Bandwidth::Middleware::Proxy
+  end
+end
+```
+
+Example
+```ruby
+from = "+18001234123123"
+application_id = "12341234"
+account_id = "123123"
+text = "sms text"
+to = "+17001234123123"
+
+body = Bandwidth::MessageRequest.new(
+  {
+    from: from,
+    application_id: application_id,
+    to: [to],
+    text: text
+  }
+)
+messaging_api_instance = Bandwidth::MessagesApi.new
+response = messaging_api_instance.create_message(account_id, body)
+
+=> #<Bandwidth::Message:0x00005f39e4efcae0 @application_id="12341234", @from="+18001234123123", @id="1737987840867jqaf7b3rad1a6fn", @owner="+18001234123123", @text="sms text", @to=["+17001234123123"]>
+```
+
+## Run tests
+```unix
+rake test
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/mock/bandwidth/decorator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "schemas/messaging_v2"
+
+module Mock
+  module Bandwidth
+    class Decorator
+      ENDPOINTS = {
+        messaging_v2: Mock::Bandwidth::Schemas::MessagingV2
+      }
+
+      class << self
+        def call(body, request)
+          body = JSON.parse(body)
+
+          case request.status
+          when 400..600
+            return body
+          end
+
+          schema = url_from(body, request)
+          # return body decorate if needed
+          return ENDPOINTS[schema].for(body, request) if schema
+
+          body
+        end
+
+        def url_from(body, request)
+          url = request.url.path
+
+          case url
+          when %r{\/api\/v2\/users\/\d+\/messages}
+            :messaging_v2
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/bandwidth/decorators/messaging_v2/message_create.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Mock
+  module Bandwidth
+    module Decorators
+      module MessagingV2
+        class MessageCreate
+          class << self
+            def decorate(body, request)
+              data = JSON.parse request.request_body
+
+              body["to"] = data["to"] if body["to"]
+              body["from"] = data["from"] if body["from"]
+              body["owner"] = data["from"] if body["owner"]
+              body["text"] = data["text"] if body["text"]
+              body["applicationId"] = data["applicationId"] if body["applicationId"]
+
+              body["id"] = message_id if body["id"]
+
+              body.to_json
+            end
+
+            def message_id
+              timestamp = (Time.now.to_f * 1000).to_i.to_s[0..12]
+              random_part = SecureRandom.alphanumeric(15).downcase
+              "#{timestamp}#{random_part}"
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module Mock
+  module Bandwidth
+    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
+
+          @app.call(env).on_complete do |request|
+            if request.response_body
+              request.body = Mock::Bandwidth::Response.call(request.response.body, request)
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+Faraday::Request.register_middleware(proxy: Mock::Bandwidth::Middleware::Proxy)

data/lib/mock/bandwidth/response.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mock
+  module Bandwidth
+    class Response
+      attr_accessor :body
+
+      def self.call(body, request)
+        body = '{}' if !body || body.empty?
+        @body = Mock::Bandwidth::Decorator.call(body, request)
+      end
+    end
+  end
+end

data/lib/mock/bandwidth/schemas/messaging_v2.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "../decorators/messaging_v2/message_create"
+
+module Mock
+  module Bandwidth
+    module Schemas
+      class MessagingV2
+        class << self
+          RESOURCES = {
+            create_message: Mock::Bandwidth::Decorators::MessagingV2::MessageCreate,
+          }
+          def for(body, request)
+            url = request.url.path
+
+            case url
+            when %r{\/api\/v2\/users\/\d+\/messages}
+              return RESOURCES[:create_message].decorate(body, request) if request.method == :post
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mock/bandwidth/version.rb

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

data/lib/mock/bandwidth.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "bandwidth/version"
+require_relative "bandwidth/middleware/proxy"
+require_relative "bandwidth/response"
+require_relative "bandwidth/decorator"
+
+module Mock
+  module Bandwidth
+    class Error < StandardError; end
+  end
+end

data/sig/mock/bandwidth.rbs

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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mock-bandwidth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Guillermo Quezada
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bandwidth-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '14.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '14.0'
+description: This repository contains Mock::Bandwidth for Bandwidth's API.
+email:
+- meemocol@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mock/bandwidth.rb
+- lib/mock/bandwidth/decorator.rb
+- lib/mock/bandwidth/decorators/messaging_v2/message_create.rb
+- lib/mock/bandwidth/middleware/proxy.rb
+- lib/mock/bandwidth/response.rb
+- lib/mock/bandwidth/schemas/messaging_v2.rb
+- lib/mock/bandwidth/version.rb
+- sig/mock/bandwidth.rbs
+homepage: https://github.com/schoolstatus/mock-bandwidth
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/schoolstatus/mock-bandwidth
+  source_code_uri: https://github.com/schoolstatus/mock-bandwidth
+  changelog_uri: https://github.com/schoolstatus/mock-bandwidth/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: This repository contains Mock::Bandwidth and Webhooks for Bandwidth's API.
+test_files: []