signalwire 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecfc761a788ea1f51afb5a6fb76b03548f688297f7b92de138e1b64c2bd01159
-  data.tar.gz: c5a163403dd5040df090cd5942f17c0d522b7b3e29672a9e1ec99a505254e403
+  metadata.gz: 4d68736f7bf37f324c9f85a604165cd994d45974d73741c90cd9290e4ef63b4c
+  data.tar.gz: f47bcfe838a3ce0576d7f2ba199f415ab5a36f23d07feef554ad3c340c20d015
 SHA512:
-  metadata.gz: 38904d4aa3d5e1b09d69677f6797f8df55db93a46d72d11ec74f3b93aeee649e6f48b4d209139638a8c8db710a2554ab42150226077eab42b1fb5fdf1b061fa5
-  data.tar.gz: f02caa8270688fa1cd482da9042949113110cde811028bd7f089426bc98497bfaa3114f25a6ff3e75f9e3fd1b617a4159557769343854e8d919855fd09e51c25
+  metadata.gz: 782c53f901d1bf44cb4bf9dd523a6268bf4bd6c165aa39223e054501f75092524e47a92ce97acb6b247cf2ad89f311fb44722bb27c5db82fbf6da7c9e88cd65e
+  data.tar.gz: 0ace788a9baf5c7c9aee04bcae89478777bdbbd7f107040da98687e5bb211d0ecccc8222fb11e6ce97037c8d773c61914538df43ab40eeb0360a1aab7358ccca

data/.gitignore

@@ -0,0 +1,55 @@
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# juwelier generated
+pkg
+tmp
+
+# Gems should not check in Gemfile.lock
+Gemfile.lock
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+.env
+*.gem

data/.rubocop.yml

@@ -1,10 +1,13 @@
 AllCops:
-  TargetRubyVersion: 2.3
   Exclude:
     - 'bin/**/*'
-    - 'signalwire-client.gemspec'
+    - 'signalwire.gemspec'
     - 'Gemfile'
     - 'vendor/**/*'
+    - 'spec/**/*'
+    - 'examples/**/*'
+    - 'tmp/**/*'
+    - 'lib/signalwire/rest/client.rb' # it is just a shim, and has a weird signature
 
 Metrics/ClassLength:
   Max: 512
@@ -12,6 +15,9 @@ Metrics/ClassLength:
 Metrics/LineLength:
   Max: 120
 
+Metrics/MethodLength:
+  Max: 20
+
 Metrics/ModuleLength:
   Max: 132
 
@@ -24,9 +30,15 @@ Layout/AccessModifierIndentation:
 Style/Documentation:
   Enabled: false
 
+# Layout/AlignArguments:
+#   Enabled: false
+
 Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
 
+Layout/AlignHash:
+  Enabled: false
+
 Style/ConditionalAssignment:
   Enabled: false
 

data/AUTHORS.md

@@ -5,3 +5,4 @@ A huge thanks to all of our contributors:
 
 
 - Luca Pradovera 
+- Edoardo Gallo

data/CHANGELOG.md

@@ -1,14 +1,39 @@
 # Changelog
+All notable changes to this project will be documented in this file.
 
-## 1.4.0
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2019-07-16
+### Added
+- Connection Retry upon disconnect.
+### Changed
+- Switch to using hostname only to specify URLs
+
+## [2.0.0-rc.1] - 2019-07-15
+### Added
+- Released new Relay Client interface.
+
+## [1.4.0] - 2019-04-12
+### Added
 - Add ability to specify domain via parameter
 - Accept both `SIGNALWIRE_SPACE_URL` and `SIGNALWIRE_API_HOSTNAME` variables for configuration
 
-## 1.3.0
-
+## [1.3.0] - 2019-01-15
+### Added
 - Fax REST API support, better tests
 
-## 1.2.0
+## [1.2.0] - 2018-12-29
+### Added
+- LaML Fax support
+
+## [1.0.0] - 2018-10-20
+### Added
+- First release!
 
-- Added Fax support
+<!---
+### Added
+### Changed
+### Removed
+### Fixed
+### Security
+-->

data/Gemfile

@@ -1,21 +1,7 @@
 source "https://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
 
-gem "twilio-ruby", "~> 5.0"
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in signalwire-client.gemspec
+gemspec
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "rspec", "~> 3.5.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "juwelier", "~> 2.1.0"
-  gem "simplecov", ">= 0"
-  gem 'rubocop',       require: false
-  gem 'bundler-audit', require: false
-  gem 'guard-rspec'
-  gem 'webmock'
-  gem 'vcr'
-end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 SignalWire
+
+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

@@ -1,98 +1,38 @@
-# signalwire-client-ruby
+# SignalWire Ruby
 
-This gem provides a client for the Signalwire LAML and REST services.
 
-It supports all of the features in the SignalWire REST API, and generation of LAML responses.
+[![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)
 
-[![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.
 
-![Drone CI](https://ci.signalwire.com/api/badges/signalwire/signalwire-ruby/status.svg)
+## Getting Started
 
-## Installation
+Read the implementation documentation, guides and API Reference at the official [Relay SDK for Ruby Documentation](https://docs.signalwire.com/topics/relay-sdk-ruby) site.
 
-Add `gem 'signalwire'` to your `Gemfile`, or simply `gem install signalwire`.
+---
 
-## SDK Usage
+## Contributing
 
-Configure your signalwire subdomain, either by setting the environment variables `SIGNALWIRE_SPACE_URL` or `SIGNALWIRE_API_HOSTNAME` to `your_subdomain.signalwire.com` within an
-initializer, or simply passing in the parameter to the constructor as seen below in the "Making a call" example:
+Relay SDK for Ruby is open source and maintained by the SignalWire team, but we are very grateful for [everyone](https://github.com/signalwire/signalwire-ruby/contributors) who has contributed and assisted so far.
 
-```ruby
-require 'signalwire/sdk'
+If you'd like to contribute, feel free to visit our [Slack channel](https://signalwire.community/) and read our developer section to get the code running in your local environment.
 
-Signalwire::Sdk.configure do |config|
-  config.hostname = "your_subdomain.signalwire.com"
-end
-```
+## Developers
 
-Then, setup a client to make requests, your `PROJECT_KEY` and `TOKEN` can be found within your Signalwire account, under Settings -> API Credentials
+The Ruby SDK is a gem built from the [signalwire-ruby](https://github.com/signalwire/signalwire-ruby) repository. To setup the dev environment follow these steps:
 
-### Making a call
+1. Install Ruby, Bundler and Rubygems. [RVM](https://rvm.io/) is an easy to use Ruby installer and environment manager.
+2. Fork the [signalwire-ruby](https://github.com/signalwire/signalwire-ruby) repository and clone it.
+3. Create a new branch from `master` for your change.
+4. Run `bundle install` to install global dependencies.
+5. Run `bundle exec guard -c` to start watching your files and specs.
+6. Make changes!
 
-```ruby
-@client = Signalwire::REST::Client.new PROJECT_KEY, TOKEN, signalwire_space_url: "your_subdomain.signalwire.com"
+## Versioning
 
-@call = @client.calls.create(
-  from: '+15551234567',
-  to: '+15557654321',
-  url: "https://cdn.signalwire.com/default-music/playlist.xml",
-  method: "GET"
-)
-```
+Relay SDK forRuby follows Semantic Versioning 2.0 as defined at <http://semver.org>.
 
-### Sending a text message
+## License
 
-```ruby
-@message = @client.messages.create(
-  from: '+15551234567',
-  to: '+15557654321',
-  body: 'This is a message from the Signalwire-Ruby library!'
-)
-```
-
-## Generating a LAML response
-
-```
-require 'signalwire/sdk'
-
-response = Signalwire::Sdk::VoiceResponse.new do |r|
-  r.say(message: 'hello there', voice: 'alice')
-  r.dial(caller_id: '+14159992222') do |d|
-    d.client 'jenny'
-  end
-end
-
-# print the result
-puts response.to_s
-```
-
-```
-<?xml version="1.0" encoding="UTF-8"?>
-<Response>
-<Say voice="alice">hello there</Say>
-<Dial callerId="+14159992222">
-<Client>jenny</Client>
-</Dial>
-</Response>
-```
-
-## Tests
-
-A `Dockerfile` is provided for your testing convenience.
-
-Run `docker run -it $(docker build -q .)` to execute the specs, or `docker run -it $(docker build -q .) sh` to get a shell.
-
-## Contributing to signalwire-client-ruby
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-## Copyright
-
-Copyright (c) 2018 SignalWire Inc. See LICENSE.txt for
-further details.
+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.

data/Rakefile

@@ -10,23 +10,6 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-require 'juwelier'
-Juwelier::Tasks.new do |gem|
-  gem.name = 'signalwire'
-  gem.homepage = 'http://github.com/signalwire/signalwire-ruby'
-  gem.license = 'MIT'
-  gem.summary = %(Ruby client for Signalwire)
-  gem.email = 'open.source@signalwire.com'
-  gem.authors = ['SignalWire Team']
-
-  # dependencies defined in Gemfile
-end
-Juwelier::RubygemsDotOrgTasks.new
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
 
 desc 'Code coverage detail'
 task :simplecov do

data/examples/relay/inbound_consumer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+# Setup your ENV with:
+# SIGNALWIRE_ACCOUNT=YOUR_SIGNALWIRE_ACCOUNT_ID
+# SIGNALWIRE_TOKEN=YOUR_SIGNALWIRE_ACCOUNT_TOKEN
+#
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class MyConsumer < Signalwire::Relay::Consumer
+  contexts ['incoming']
+
+  def on_incoming_call(call)
+    call.answer
+    call.play_tts 'the quick brown fox jumps over the lazy dog'
+
+    call.hangup
+  end
+end
+
+MyConsumer.new.run

data/examples/relay/inbound_dial.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+# Setup your ENV with:
+# SIGNALWIRE_ACCOUNT=YOUR_SIGNALWIRE_ACCOUNT_ID
+# SIGNALWIRE_TOKEN=YOUR_SIGNALWIRE_ACCOUNT_TOKEN
+#
+# Set logging to debug for testing
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class MyConsumer < Signalwire::Relay::Consumer
+  contexts ['incoming']
+
+  def on_incoming_call(call)
+    call.answer
+    call.play_tts 'connecting you to the clock service'
+    call.connect [[{ type: 'phone', params: { to_number: '+12027621401', from_number: ENV['FROM_NUMBER'], timeout: 30 } }]]
+    sleep 20
+    call.hangup
+  end
+end
+
+MyConsumer.new.run

data/examples/relay/outbound_collect.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+# Set logging to debug for testing
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class OutboundConsumer < Signalwire::Relay::Consumer
+  def ready
+    dial_result = client.calling.new_call(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER']).dial
+    collect_params = { "initial_timeout": 10.0, "digits": { "max": 1, "digit_timeout": 5.0 } }
+    result = dial_result.call.prompt_tts( collect_params, 'how many hamburgers would you like to order?')
+
+    dial_result.call.play_tts "You ordered #{result.result} hamburgers. Thank you!"
+    dial_result.call.hangup
+  # this makes it so the errors don't stop the process
+  rescue StandardError => e
+    logger.error e.inspect
+    logger.error e.backtrace
+  end
+end
+
+OutboundConsumer.new.run

data/examples/relay/outbound_consumer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+%w[
+  bundler/setup
+  signalwire
+].each { |f| require f }
+
+# Set logging to debug for testing
+Signalwire::Logger.logger.level = ::Logger::DEBUG
+
+class OutboundConsumer < Signalwire::Relay::Consumer
+  def ready
+    logger.info 'Dialing out'
+    call = client.calling.new_call(from: ENV['FROM_NUMBER'], to: ENV['TO_NUMBER'])
+    call.dial
+    call.play_tts 'the quick brown fox jumps over the lazy dog', 'en-US', 'male'
+    call.hangup
+  end
+end
+
+OutboundConsumer.new.run