signalwire 2.3.4 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d31f18c614ab0890b0c3000c45f607b636c8c3a3b7ad51d1e9dffae4c3b30165
-  data.tar.gz: 6ef1eeb8106c935d12beb8edafb67004d14c012761c43c675a9ce4d430c794d6
+  metadata.gz: 2041c5f950f029c9b9d7d6aab709868d0d6ff19eab4fe288171d145ec310b996
+  data.tar.gz: 7f00185024b6fbdd22d9bf21af089cc29fdecfce59ffec43ab861d8252b96ba6
 SHA512:
-  metadata.gz: 4535d5d33d7d8152ffd349d0fbeb4cb544fc71931fb72f93c2c866eda4957249ace7b5337472193ebd58f0f6a987f546a226edc97618fb8bef03652162b534db
-  data.tar.gz: 6887060feada342534a3b4a365eb058e93276aa50ecd8e88456d1b4495e6aee7aa47be22e26adc22dfb292e24a0291ffe3376e06b6359d27fa6d0aaffeaba457
+  metadata.gz: 130c9720b336190492e270d82e54b7958f44f3e0523fc41a24f6721ddc0ff22c00e0bb87317cee256fb92a233177433161c5d1536bdbe487344b8d7ae7a1263f
+  data.tar.gz: cdb660adf6bbced09c63d4bbd331dd35c7d7697fcf4d9675b4ac783889e8604efcd720b827998fb548cf304253f4522666e9c366a8abb1bed5cd6b7f5ffbc9ec

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2']
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rspec

data/CHANGELOG.md

@@ -5,6 +5,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
  ## [Unreleased]
 
+## [2.4.0] - 2023-
+### Added
+- Add Webhook `ValidateRequest`
+
 ## [2.3.4] - 2020-09-09
 ### Fixed
 - Correctly ignore non-call events and clear handlers on call end

data/README.md

@@ -1,7 +1,8 @@
 # SignalWire Ruby
 
 
-[![Build Status](https://ci.signalwire.com/api/badges/signalwire/signalwire-ruby/status.svg)](https://ci.signalwire.com/signalwire/signalwire-ruby) [![Gem Version](https://badge.fury.io/rb/signalwire.svg)](https://badge.fury.io/rb/signalwire)
+[![CI](https://github.com/signalwire/signalwire-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/signalwire/signalwire-ruby/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/signalwire.svg)](https://badge.fury.io/rb/signalwire)
 
 The Relay SDK for Ruby enables Ruby developers to connect and use SignalWire's Relay APIs within their own Ruby code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications.
 
@@ -34,5 +35,5 @@ Relay SDK forRuby follows Semantic Versioning 2.0 as defined at <http://semver.o
 
 ## License
 
-Relay SDK for Ruby is copyright © 2018-2019
-[SignalWire](http://signalwire.com). It is free software, and may be redistributed under the terms specified in the [MIT-LICENSE](https://github.com//signalwire/signalwire-ruby/blob/master/LICENSE) file.
+Relay SDK for Ruby is copyright © 2018-2023
+[SignalWire](http://signalwire.com). It is free software, and may be redistributed under the terms specified in the [MIT-LICENSE](https://github.com//signalwire/signalwire-ruby/blob/master/LICENSE) file.

data/lib/signalwire/sdk.rb

@@ -10,6 +10,7 @@ require 'signalwire/sdk/voice_response'
 require 'signalwire/sdk/fax_response'
 require 'signalwire/sdk/messaging_response'
 require 'signalwire/rest/client'
+require 'signalwire/webhook/validate_request'
 
 module Signalwire
   module Sdk

data/lib/signalwire/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Signalwire
-  VERSION = '2.3.4'
+  VERSION = '2.4.0'
 end

data/lib/signalwire/webhook/validate_request.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'openssl'
+
+module Signalwire::Webhook
+  class ValidateRequest
+    attr_reader :private_key
+
+    def initialize(private_key)
+      @private_key = private_key
+      raise ArgumentError, 'Private key is required' if @private_key.nil?
+    end
+
+    def validate(url, raw_body, header)
+      return false if header.nil? || url.nil?
+
+      # compatibility validation for POST parameters of x-www-form-urlencoded requests
+      if raw_body.is_a?(Hash)
+        return validate_with_compatibility_api(url, raw_body, header)
+      end
+
+      # relay json validation
+      payload = url + raw_body
+      expected_signature = compute_signature(payload)
+      valid = secure_compare(expected_signature, header)
+
+      return true if valid
+
+      # fallback compatibilty json validation
+      validate_with_compatibility_api(url, raw_body, header)
+    end
+
+    private
+
+    def validate_with_compatibility_api(url, params, signature)
+      validator = Twilio::Security::RequestValidator.new(private_key)
+      validator.validate(url, params, signature)
+    end
+
+    def compute_signature(payload)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha1'), private_key, payload)
+    end
+
+    # Constant time string comparison, from ActiveSupport
+    def secure_compare(a, b)
+      return false if a.nil? || b.nil?
+      return false unless a.bytesize == b.bytesize
+
+      l = a.unpack "C#{a.bytesize}"
+
+      res = 0
+      b.each_byte { |byte| res |= byte ^ l.shift }
+      res == 0
+    end
+  end
+end

data/signalwire.gemspec

@@ -27,17 +27,17 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'bundler-audit', '~> 0.6'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
-  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rdoc', '~> 6.1'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.67'
   spec.add_development_dependency 'ruby-prof', '~> 0.17'
   spec.add_development_dependency 'simplecov', '~> 0.16'
-  spec.add_development_dependency 'vcr', '~> 4.0'
+  spec.add_development_dependency 'vcr', '~> 5.0'
   spec.add_development_dependency 'webmock', '~> 3.5'
 
   spec.add_dependency 'twilio-ruby', '~> 5.0'
-  spec.add_dependency 'faye-websocket', '~> 0.10'
+  spec.add_dependency 'faye-websocket', '~> 0.11'
   spec.add_dependency 'concurrent-ruby', '~> 1.1'
   spec.add_dependency 'has-guarded-handlers', '~> 1.6.3'
   spec.add_dependency 'logger', '~> 1.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signalwire
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.4.0
 platform: ruby
 authors:
 - SignalWire Team
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -234,7 +234,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: 
+description:
 email:
 - open.source@signalwire.com
 executables: []
@@ -242,7 +242,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
-- ".drone.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -350,12 +351,13 @@ files:
 - lib/signalwire/sdk/twilio_set_host.rb
 - lib/signalwire/sdk/voice_response.rb
 - lib/signalwire/version.rb
+- lib/signalwire/webhook/validate_request.rb
 - signalwire.gemspec
 homepage: https://github.com/signalwire/signalwire-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -370,8 +372,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.7
+signing_key:
 specification_version: 4
 summary: Ruby client for Signalwire
 test_files: []

data/.drone.yml

@@ -1,14 +0,0 @@
-kind: pipeline
-name: default
-
-steps:
-- name: test
-  image: ruby:2.6
-  commands:
-  - gem install bundler
-  - bundle install --jobs=3 --retry=3
-  - bundle exec rspec
-
-trigger:
-  event: push
-