telnyx 2.2.0 → 2.7.0

data/Gemfile

@@ -6,7 +6,7 @@ gemspec
 
 group :development do
   gem "coveralls", require: false
-  gem "faraday", "0.15.4"
+  gem "faraday", "~> 1.0"
   gem "mocha", "~> 0.13.2"
   gem "rake"
   gem "shoulda-context"
@@ -22,20 +22,24 @@ group :development do
   gem "guard"
   gem "guard-rake"
   gem "guard-rubocop"
-  gem "rubocop", "0.50.0"
+  gem "rubocop", "~> 1.6"
+
+  # debugging
+  # gem 'httplog' # when included logs all http requests
+  # gem 'awesome_print'
 
   # Rack 2.0+ requires Ruby >= 2.2.2 which is problematic for the test suite on
   # older Ruby versions. Check Ruby the version here and put a maximum
   # constraint on Rack if necessary.
   if RUBY_VERSION >= "2.2.2"
-    gem "rack", ">= 2.0.6"
+    gem "rack", ">= 2.1.4"
   else
     gem "rack", ">= 1.6.11", "< 2.0" # rubocop:disable Bundler/DuplicatedGem
   end
 
   platforms :mri do
-    gem "byebug"
-    gem "pry"
-    gem "pry-byebug"
+    # gem "byebug"
+    # gem "pry"
+    # gem "pry-byebug"
   end
 end

data/README.md

@@ -1,6 +1,6 @@
 # Telnyx Ruby Library
 
-[![Build Status](https://travis-ci.org/team-telnyx/telnyx-ruby.svg?branch=master)](https://travis-ci.org/team-telnyx/telnyx-ruby)
+![Build Status](https://github.com/team-telnyx/telnyx-ruby/workflows/Ruby/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/team-telnyx/telnyx-ruby/badge.svg?branch=master)](https://coveralls.io/github/team-telnyx/telnyx-ruby?branch=master)
 [![Join Slack](https://img.shields.io/badge/join-slack-infomational)](https://joinslack.telnyx.com/)
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+2.7.0

data/bin/telnyx-console

@@ -13,5 +13,10 @@ IRB.conf[:PROMPT_MODE] = :SIMPLE
 IRB.conf[:AUTO_INDENT] = true
 
 puts "Loaded gem 'telnyx'"
+def load_mock_settings!
+  Telnyx.api_base = "http://localhost:12111"
+  Telnyx.api_key = "KEYSUPERSECRET"
+  nil
+end
 
 IRB.start

data/examples/2 factor authentication/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "amazing_print"
+gem "telnyx", path: "../../."
+gem "tty-prompt"

data/examples/2 factor authentication/main.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "telnyx"
+require "amazing_print" # for displaying the api requests nicely.
+require "tty-prompt" # for prettier interactive prompts.
+
+Telnyx.api_key = ENV["TELNYX_KEY"] # Set your key here
+raise "Please set your API key in this script, or set the TELNYX_KEY env variable!" unless Telnyx.api_key
+
+class Demo
+  def initialize
+    @prompt = TTY::Prompt.new
+  end
+
+  def start
+    create_profile
+    puts "Profile object returned from API:"
+    ap @profile
+
+    verify
+    puts "Verification object returned from API:"
+    ap @verification
+
+    puts "A SMS should be sent to the phone number soon."
+    check_prompt
+  end
+
+  def create_profile
+    # Ask what to call the new verification profile.
+    profile_name = @prompt.ask("Profile name:", default: "demo profile")
+    # Check if we already created a demo profile.
+    existing_profile = Telnyx::VerifyProfile.list.first { |p| p.name == profile_name }
+    # Check if we should use the existing one.
+    return @profile = existing_profile if existing_profile && @prompt.yes?(%(Found a profile already called "#{profile_name}", would you like to use that instead of creating a new profile?))
+
+    # Create a new profile.
+    @profile = Telnyx::VerifyProfile.create name: profile_name
+  end
+
+  def verify
+    # Create a new verification, this will send a code via SMS to the number provided.
+    @verification = Telnyx::Verification.create(
+      type: "sms",
+      verify_profile_id: @profile.id,
+      phone_number: @prompt.ask("Enter a phone number to send a verification code to (must be e164 format, e.g., +15554443333):", value: "+1") { |p| p.validate(/^\+?[1-9]\d{1,14}$/) }
+    )
+  end
+
+  def check_prompt
+    loop do
+      # Ask the user for the verification code.
+      code = @prompt.ask "Enter verification code:"
+      # Ask the api if this is the correct code.
+      response = Telnyx::Verification.submit_code code: code, phone_number: @verification.phone_number
+      puts "Api responded with:"
+      ap response
+
+      # If it's not the right code try again.
+      break if response.response_code == "accepted"
+
+      puts "\e[31mIncorrect code, try again!\e[0m"
+      create_profile if @prompt.yes?("Resend code?")
+    end
+  end
+end
+
+Demo.new.start

data/examples/2 factor authentication/readme.md

@@ -0,0 +1,5 @@
+# Usage
+```
+bundle
+bundle exec ruby main.rb
+```

data/examples/fax/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "amazing_print"
+gem "sinatra"
+gem "telnyx", path: "../../."

data/examples/fax/config.yaml

@@ -0,0 +1,4 @@
+fax_app_id:
+outbound_connection_id:
+to:
+from:

data/examples/fax/fax.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "telnyx"
+require_relative "options"
+require "sinatra/base"
+require "json"
+require "amazing_print"
+require "uri"
+
+class WebhookServer < Sinatra::Base
+  set :port, 9090
+
+  def initialize
+    super
+    Thread.new { telnyx_setup }
+  end
+
+  def telnyx_setup
+    @fax_application = Telnyx::FaxApplication.retrieve CONFIG.fax_app_id
+    @fax_application.webhook_event_url = CONFIG.webhook_url
+    @fax_application.save
+
+    puts "## Fax Send Request ##"
+    ap @sent_fax = Telnyx::Fax.create(
+      connection_id: CONFIG["outbound_connection_id"],
+      media_url: CONFIG.document_url,
+      to: CONFIG.to,
+      from: CONFIG.from,
+      outbound_voice_profile_id: CONFIG.outbound_voice_profile_id
+    )
+  end
+
+  # Receive webhooks
+  post "/*" do
+    hook = JSON.parse(request.body.read, symbolize_names: true)
+    puts "## Received Webhook ##"
+    ap hook
+    200
+  end
+end
+
+WebhookServer.run!

data/examples/fax/options.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Helper script to parse the command line options.
+
+require "optparse"
+require "ostruct"
+require "yaml"
+
+CONFIG = OpenStruct.new(
+  document_url: "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
+  **YAML.safe_load(open("config.yaml")).to_h
+)
+OptionParser.new do |opts|
+  opts.banner = "Telnyx fax demo\nUsage: bundle exec fax.rb -- [options]"
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+
+  opts.on(
+    "-h=URL", "--webhook-url=URL",
+    "[REQUIRED] URL to send webhook events to. This should be an address exposed to the internet. For testing purposes try Ngrok or Hookbin."
+  ) { |url| CONFIG.webhook_url = url }
+
+  opts.on(
+    "-k=KEY", "--api-key=KEY", "[REQUIRED] Telnyx API key."
+  ) { |key| CONFIG.api_key = Telnyx.api_key = key }
+
+  opts.on(
+    "--to=NUMBER", "Phone number to send a fax to"
+  ) { |number| CONFIG.to = number }
+
+  opts.on(
+    "--document-url=URL", "URL for document to fax. Default is https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
+  ) { |url| CONFIG.document_url = url }
+end.parse!
+
+missing_args = %i[webhook_url api_key] - CONFIG.to_h.keys
+missing_args.any? and raise OptionParser::MissingArgument, "missing the following options: [#{missing_args.join ', '}]. Use --help for more information."
+CONFIG.to_h.values.any?(&:nil?) and raise "Missing config values, check config.yaml"

data/examples/fax/readme.md

@@ -0,0 +1,18 @@
+# Usage
+
+For convince use a utility like Ngrok or Hookbin to expose the demo server to the internet. For example with Ngrok run the following: `ngrok http 9090` and copy the exposed url, you will need this to properly complete the setup below.
+
+Before you can use the demo application you will need to login to your telnyx portal and configure the following:
+
+1. You will need to setup an inbound and an outbound Fax Application for this demo.
+2. Create two phone numbers:
+    - One for inbound faxes, this will need to be associated with a fax application.
+    - One for outbound faxes. 
+3. You will also need to create a SIP Connection for your outbound faxes, be sure to configure it to use your webhook url.
+
+Finally you will need to fill out `config.yaml` with the IDs listed, as well as with the outbound and inbound phone numbers.
+
+```
+bundle
+bundle exec ruby main.rb --api-key=<YOUR API KEY>
+```

data/lib/telnyx.rb

@@ -40,12 +40,14 @@ require "telnyx/address"
 require "telnyx/alphanumeric_sender_id"
 require "telnyx/available_phone_number"
 require "telnyx/billing_group"
+require "telnyx/call_control_application"
 require "telnyx/call"
 require "telnyx/conference"
 require "telnyx/connection"
-require "telnyx/call_control_application"
 require "telnyx/credential_connection"
 require "telnyx/event"
+require "telnyx/fax"
+require "telnyx/fax_application"
 require "telnyx/fqdn_connection"
 require "telnyx/fqdn"
 require "telnyx/ip_connection"
@@ -64,6 +66,8 @@ require "telnyx/portout"
 require "telnyx/public_key"
 require "telnyx/regulatory_requirement"
 require "telnyx/sim_card"
+require "telnyx/verification"
+require "telnyx/verify_profile"
 require "telnyx/wireless_detail_records_report"
 
 module Telnyx

data/lib/telnyx/api_operations/create.rb

@@ -4,7 +4,12 @@ module Telnyx
   module APIOperations
     module Create
       def create(params = {}, opts = {})
-        resp, opts = request(:post, resource_url, params, opts)
+        if opts.respond_to? :fetch
+          url = opts.fetch(:resource_url, nil)
+          opts.delete :resource_url
+        end
+        url ||= resource_url
+        resp, opts = request(:post, url, params, opts)
         Util.convert_to_telnyx_object(resp.data, opts)
       end
     end

data/lib/telnyx/api_operations/save.rb

@@ -22,7 +22,7 @@ module Telnyx
             end
           end
 
-          resp, opts = request(:patch, "#{resource_url}/#{id}", params, opts)
+          resp, opts = request(:patch, identified_resource_url(id), params, opts)
           Util.convert_to_telnyx_object(resp.data, opts)
         end
       end

data/lib/telnyx/api_resource.rb

@@ -10,17 +10,36 @@ module Telnyx
     # own endpoints, but there are certain cases where this is allowed.
     attr_accessor :save_with_parent
 
+    class << self
+      def inherited(subclass)
+        super
+        @descendants ||= []
+        @descendants << subclass
+      end
+
+      attr_reader :descendants
+    end
+
     def self.class_name
       name.split("::")[-1]
     end
 
-    def self.resource_url
+    def self.resource_url(inner_id = nil)
       if self == APIResource
         raise NotImplementedError, "APIResource is an abstract class. You should perform actions on its subclasses"
       end
       # Namespaces are separated in object names with periods (.) and in URLs
       # with forward slashes (/), so replace the former with the latter.
-      const_defined?("RESOURCE_PATH") ? "/v2/#{self::RESOURCE_PATH}" : "/v2/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
+      return "/v2/#{resource_path(inner_id)}" if respond_to?("resource_path")
+      return "/v2/#{self::RESOURCE_PATH}" if const_defined?("RESOURCE_PATH")
+
+      "/v2/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
+    end
+
+    def self.identified_resource_url(id)
+      return "/v2/#{resource_path(id)}" if respond_to?("resource_path")
+
+      "#{resource_url}/#{CGI.escape(id)}"
     end
 
     # A metaprogramming call that specifies that a field of a resource can be
@@ -51,6 +70,8 @@ module Telnyx
       unless (id = self["id"])
         raise InvalidRequestError, "Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}"
       end
+      return self.class.resource_url(id).to_s if self.class.respond_to?("resource_path") # Use resource_path defined paths
+
       "#{self.class.resource_url}/#{CGI.escape(id)}"
     end
 
@@ -61,7 +82,7 @@ module Telnyx
 
     def self.retrieve(id, opts = {})
       opts = Util.normalize_opts(opts)
-      instance = new(id, opts)
+      instance = new(id, **opts)
       instance.refresh
       instance
     end

data/lib/telnyx/call.rb

@@ -33,7 +33,9 @@ module Telnyx
 
     ACTIONS = %w[reject answer hangup bridge speak fork_start fork_stop
                  gather_using_audio gather_using_speak playback_start
-                 playback_stop record_start record_stop send_dtmf transfer].freeze
+                 playback_stop record_start record_stop send_dtmf transfer
+                 transcription_start transcription_stop record_pause
+                 record_resume gather_stop refer enqueue leave_queue].freeze
 
     ACTIONS.each do |action|
       nested_resource_class_methods action,

data/lib/telnyx/conference.rb

@@ -6,7 +6,7 @@ module Telnyx
     extend APIOperations::Create
     extend APIOperations::NestedResource
 
-    ACTIONS = %w[join mute unmute hold unhold].freeze
+    ACTIONS = %w[join mute unmute hold unhold speak play dial_participant update].freeze
 
     ACTIONS.each do |action|
       nested_resource_class_methods action,
@@ -14,6 +14,22 @@ module Telnyx
                                     operations: [:create],
                                     instance_methods: { create: action }
     end
+
+    nested_resource_class_methods "record_start",
+                                  path: ["actions", "record_start"],
+                                  operations: [:create],
+                                  instance_methods: { create: "start_recording" }
+
+    nested_resource_class_methods "record_stop",
+                                  path: ["actions", "record_stop"],
+                                  operations: [:create],
+                                  instance_methods: { create: "stop_recording" }
+
+    nested_resource_class_methods "participants",
+                                  path: "participants",
+                                  operations: [:list],
+                                  instance_methods: { list: "participants" }
+
     OBJECT_NAME = "conference".freeze
   end
   Conferences = Conference # Name change without breaking existing code

data/lib/telnyx/fax.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class Fax < APIResource
+    extend Telnyx::APIOperations::List
+    extend Telnyx::APIOperations::Create
+    include Telnyx::APIOperations::Delete
+    include Telnyx::APIOperations::Save
+
+    OBJECT_NAME = "fax".freeze
+    RESOURCE_PATH = "faxes".freeze
+  end
+end

data/lib/telnyx/fax_application.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class FaxApplication < APIResource
+    extend Telnyx::APIOperations::List
+    extend Telnyx::APIOperations::Create
+    include Telnyx::APIOperations::Delete
+    include Telnyx::APIOperations::Save
+
+    OBJECT_NAME = "fax_application".freeze
+  end
+end