telnyx 0.0.8 → 2.5.0

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 
 group :development do
   gem "coveralls", require: false
+  gem "faraday", "~> 1.0"
   gem "mocha", "~> 0.13.2"
   gem "rake"
   gem "shoulda-context"
@@ -21,20 +22,20 @@ group :development do
   gem "guard"
   gem "guard-rake"
   gem "guard-rubocop"
-  gem "rubocop", "0.50.0"
+  gem "rubocop", "~> 1.6"
 
   # 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,7 +1,8 @@
 # Telnyx Ruby Library
 
-[![Build Status](https://travis-ci.org/team-telnyx/telnyx-ruby.svg?branch=master)](https://travis-ci.org/telnyx/telnyx-ruby)
-[![Coverage Status](https://coveralls.io/repos/github/team-telnyx/telnyx-ruby/badge.svg?branch=master)](https://coveralls.io/github/telnyx/telnyx-ruby?branch=master)
+![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/)
 
 The Telnyx Ruby library provides convenient access to the Telnyx API from
 applications written in the Ruby language. It includes a pre-defined set of
@@ -34,7 +35,7 @@ If you want to build the gem from source:
 
 ### Requirements
 
-* Ruby 2.0+.
+* Ruby 2.1.0+
 
 ### Bundler
 
@@ -65,6 +66,44 @@ Telnyx::MessagingProfile.list()
 Telnyx::MessagingProfile.retrieve("123")
 ```
 
+
+### Iterating over a resource
+
+API resources are paginated and the library comes with a handful of methods to
+ease dealing with them seemlessly.
+
+```ruby
+# list messaging profiles
+first_page = Telnyx::MessagingProfile.list()
+
+# check whether there are more pages to go through
+if first_page.more?
+  puts("There are still more pages to go.")
+else
+  puts("This is the last page.")
+end
+
+# get current page's size and number
+first_page.page_size
+first_page.page_number
+
+# fetch the next and previous pages
+second_page = first_page.next_page
+first_page = second_page.previous_page
+
+# iterate over the results of a *single page*
+second_page.each do |messaging_profile|
+  puts(messaging_profile.id)
+end
+
+# iterate over *all of the messaging profiles* starting at `first_page`
+# similar to `each`, but requests subsequent pages as needed
+first_page.auto_paging_each do |messaging_profile|
+  puts(messaging_profile.id)
+end
+```
+
+
 ### Configuring a Client
 
 While a default HTTP client is used by default, it's also possible to have the

data/VERSION

@@ -1 +1 @@
-0.0.8
+2.5.0

data/bin/telnyx-console

@@ -5,12 +5,18 @@
 require "irb"
 require "irb/completion"
 
-require "#{::File.dirname(__FILE__)}/../lib/telnyx"
+$LOAD_PATH.unshift File.expand_path("lib")
+require "telnyx"
 
 # Config IRB to enable --simple-prompt and auto indent
 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

@@ -36,19 +36,39 @@ require "telnyx/api_resource"
 require "telnyx/singleton_api_resource"
 require "telnyx/webhook"
 
+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/conferences"
+require "telnyx/conference"
+require "telnyx/connection"
+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"
+require "telnyx/ip"
 require "telnyx/message"
 require "telnyx/messaging_phone_number"
 require "telnyx/messaging_profile"
+require "telnyx/number_lookup"
+require "telnyx/number_order_document"
 require "telnyx/number_order"
 require "telnyx/number_reservation"
+require "telnyx/outbound_voice_profile"
+require "telnyx/phone_number_regulatory_requirement"
 require "telnyx/phone_number"
+require "telnyx/portout"
 require "telnyx/public_key"
-require "telnyx/sim_card.rb"
+require "telnyx/regulatory_requirement"
+require "telnyx/sim_card"
+require "telnyx/verification"
+require "telnyx/verify_profile"
+require "telnyx/wireless_detail_records_report"
 
 module Telnyx
   @app_info = nil

data/lib/telnyx/address.rb

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

data/lib/telnyx/api_operations/list.rb

@@ -14,7 +14,7 @@ module Telnyx
         #
         # just for general cleanliness, remove any paging options
         obj.filters = filters.dup
-        obj.filters.delete(:page)
+        # obj.filters.delete(:page) # undo this as it interferes with the pagination system...
 
         obj
       end

data/lib/telnyx/api_operations/nested_resource.rb

@@ -20,8 +20,8 @@ module Telnyx
 
         resource_url_method = :"#{resource}s_url"
         define_singleton_method(resource_url_method) do |id, nested_id = nil|
-          raise ArgumentError, "id is required" if id.nil?
-          url = "#{resource_url}/#{CGI.escape(id)}/#{path}"
+          # raise ArgumentError, "id is required" if id.nil?
+          url = id.nil? ? "#{resource_url}/#{path}" : "#{resource_url}/#{CGI.escape(id)}/#{path}"
           url += "/#{CGI.escape(nested_id)}" unless nested_id.nil?
           url
         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

@@ -14,15 +14,24 @@ module Telnyx
       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.
+      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
     # its own type of API resource (say a nested card under an account for
     # example), and if that resource is set, it should be transmitted to the
@@ -51,6 +60,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 +72,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