telnyx 0.0.8 → 2.5.0

data/test/telnyx/conference_test.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class ConferenceTest < Test::Unit::TestCase
+    setup do
+      @conference = Conference.create call_control_id: "foobar", name: "conference!"
+    end
+    should "create conference" do
+      assert_requested :post, "#{Telnyx.api_base}/v2/conferences"
+      assert_kind_of Conference, @conference
+    end
+
+    should "retrieve conference" do
+      conference = Conference.retrieve "foobar"
+      assert_kind_of Conference, conference
+      assert_requested :get, "#{Telnyx.api_base}/v2/conferences/foobar"
+    end
+
+    should "list conferences" do
+      conferences = Conference.list
+
+      assert_requested :get, "#{Telnyx.api_base}/v2/conferences"
+      assert_kind_of ListObject, conferences
+      assert_kind_of Conference, conferences.first
+    end
+
+    should "list participants" do
+      participants = @conference.participants
+      assert_requested :get, "#{Telnyx.api_base}/v2/conferences/#{@conference.id}/participants"
+      assert_kind_of ListObject, participants
+    end
+
+    should "have nested command instance methods" do
+      assert defined? @conference.join
+      assert defined? @conference.mute
+      assert defined? @conference.unmute
+      assert defined? @conference.unhold
+      assert defined? @conference.play
+      assert defined? @conference.start_recording
+      assert defined? @conference.stop_recording
+      assert defined? @conference.speak
+      assert defined? @conference.dial_participant
+      assert defined? @conference.update
+    end
+
+    context "commands" do
+      should "join" do
+        @conference.join call_control_id: "foo_bar_baz"
+        assert_requested :post, action_url(@conference, "join")
+      end
+
+      should "mute" do
+        @conference.mute
+        assert_requested :post, action_url(@conference, "mute")
+      end
+
+      should "unmute" do
+        @conference.unmute
+        assert_requested :post, action_url(@conference, "unmute")
+      end
+
+      should "hold" do
+        @conference.hold
+        assert_requested :post, action_url(@conference, "hold")
+      end
+
+      should "unhold" do
+        @conference.unhold call_control_ids: %w[foo bar baz]
+        assert_requested :post, action_url(@conference, "unhold")
+      end
+
+      should "play" do
+        @conference.play audio_url: "https://example.com/audio.mp3"
+        assert_requested :post, action_url(@conference, "play")
+      end
+
+      should "start recording" do
+        @conference.start_recording channels: "dual", format: "mp3"
+        assert_requested :post, action_url(@conference, "record_start")
+      end
+
+      should "stop recording" do
+        @conference.stop_recording
+        assert_requested :post, action_url(@conference, "record_stop")
+      end
+
+      should "speak" do
+        @conference.speak language: "en-US", payload: "test speech", voice: "female"
+        assert_requested :post, action_url(@conference, "speak")
+      end
+
+      should "dial participant" do
+        @conference.dial_participant call_control_id: "foo", to: "+12223334444", from: "+12223335555"
+        assert_requested :post, action_url(@conference, "dial_participant")
+      end
+
+      should "update" do
+        @conference.update call_control_id: "foo"
+        assert_requested :post, action_url(@conference, "update")
+      end
+    end
+
+    def create_call
+      Telnyx::Call.create connection_id: "12345", to: "+15550001111", from: "+15550002222"
+    end
+
+    def action_url(conf, action)
+      "#{Telnyx.api_base}/v2/conferences/#{conf.id}/actions/#{action}"
+    end
+  end
+end

data/test/telnyx/connection_test.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class ConnectionTest < Test::Unit::TestCase
+    should "list connections" do
+      connections = Connection.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/connections"
+      assert_kind_of ListObject, connections
+      assert connections.first.is_a?(Connection) ||
+             connections.first.is_a?(IPConnection) ||
+             connections.first.is_a?(FQDNConnection) ||
+             connections.first.is_a?(CredentialConnection),
+             "Unexpected type: #{connections.first.class}"
+    end
+
+    should "retrieve a connection" do
+      connection = Connection.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/connections/id"
+      assert connection.is_a?(Connection) ||
+             connection.is_a?(IPConnection) ||
+             connection.is_a?(FQDNConnection) ||
+             connection.is_a?(CredentialConnection),
+             "Unexpected type: #{connection.class}"
+    end
+  end
+end

data/test/telnyx/credential_connection_test.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class CredentialConnectionTest < Test::Unit::TestCase
+    should "list credential connections" do
+      credential_connections = CredentialConnection.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/credential_connections"
+      assert_kind_of ListObject, credential_connections
+      assert_kind_of CredentialConnection, credential_connections.first
+    end
+
+    should "create credential connection" do
+      CredentialConnection.create(
+        connection_name: "Test connection_name",
+        user_name: "Test user_name",
+        password: "correct-horse-battery-staple"
+      )
+      assert_requested :post, "#{Telnyx.api_base}/v2/credential_connections"
+    end
+
+    should "retrieve credential connection" do
+      credential_connection = CredentialConnection.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/credential_connections/id"
+      assert_kind_of CredentialConnection, credential_connection
+    end
+
+    should "delete credential connection" do
+      credential_connection = CredentialConnection.retrieve("id")
+
+      credential_connection.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/credential_connections/id"
+    end
+
+    should "update credential connection" do
+      credential_connection = CredentialConnection.retrieve("id")
+
+      credential_connection.active = false
+      credential_connection.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/credential_connections/id"
+    end
+  end
+end

data/test/telnyx/errors_test.rb

@@ -7,16 +7,16 @@ module Telnyx
     context "#to_s" do
       should "convert to string" do
         e = TelnyxError.new([{ "title" => "Missing required attributes" }])
-        assert_equal "Missing required attributes Full details: [{\"title\"=>\"Missing required attributes\"}]", e.to_s
+        assert_equal 'Missing required attributes Full details: [{"title"=>"Missing required attributes"}]', e.to_s
 
         e = TelnyxError.new([{ "title" => "Missing required attributes" }], http_status: 422)
-        assert_equal "(Status 422) Missing required attributes Full details: [{\"title\"=>\"Missing required attributes\"}]", e.to_s
+        assert_equal '(Status 422) Missing required attributes Full details: [{"title"=>"Missing required attributes"}]', e.to_s
 
         e = TelnyxError.new([{ "title" => "Missing required attributes" }], http_status: nil, http_body: nil, json_body: nil, http_headers: { request_id: "request-id" })
-        assert_equal "(Request request-id) Missing required attributes Full details: [{\"title\"=>\"Missing required attributes\"}]", e.to_s
+        assert_equal '(Request request-id) Missing required attributes Full details: [{"title"=>"Missing required attributes"}]', e.to_s
 
         e = TelnyxError.new([{ "title" => "Missing required attributes" }, { "title" => "Phone number must be in +E.164 format" }], http_status: nil, http_body: nil, json_body: nil, http_headers: { request_id: "request-id" })
-        assert_equal "(Request request-id) Missing required attributes plus 1 other error. Full details: [{\"title\"=>\"Missing required attributes\"}, {\"title\"=>\"Phone number must be in +E.164 format\"}]", e.to_s
+        assert_equal '(Request request-id) Missing required attributes plus 1 other error. Full details: [{"title"=>"Missing required attributes"}, {"title"=>"Phone number must be in +E.164 format"}]', e.to_s
       end
     end
   end

data/test/telnyx/fax_application_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class FaxApplicationTest < Test::Unit::TestCase
+    should "fetch index" do
+      fax_applications = FaxApplication.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/fax_applications"
+      assert_kind_of ListObject, fax_applications
+      assert_kind_of FaxApplication, fax_applications.first
+    end
+
+    should "create" do
+      fax_application = FaxApplication.create application_name: "foo", webhook_event_url: "https://foo.bar.com"
+      assert_requested :post, "#{Telnyx.api_base}/v2/fax_applications"
+      assert_kind_of FaxApplication, fax_application
+    end
+
+    should "retrieve" do
+      fax_application = FaxApplication.retrieve "foo"
+      assert_requested :get, "#{Telnyx.api_base}/v2/fax_applications/foo"
+      assert_kind_of FaxApplication, fax_application
+    end
+
+    should "delete" do
+      fax_application = FaxApplication.retrieve "foo"
+      fax_application.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/fax_applications/foo"
+    end
+  end
+end

data/test/telnyx/fax_test.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+module Telnyx
+  class FaxTest < Test::Unit::TestCase
+    should "fetch index" do
+      faxes = Fax.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/faxes"
+      assert_kind_of ListObject, faxes
+      assert_kind_of Fax, faxes.first
+    end
+
+    should "send fax" do
+      fax = Fax.create connection_id: "foo", media_url: "example.com", to: "+13127367276"
+      assert_requested :post, "#{Telnyx.api_base}/v2/faxes"
+      assert_kind_of Fax, fax
+    end
+
+    should "view fax" do
+      fax = Fax.retrieve "foo"
+      assert_requested :get, "#{Telnyx.api_base}/v2/faxes/foo"
+      assert_kind_of Fax, fax
+    end
+
+    should "delete fax" do
+      omit "!!waiting for mock!!"
+      fax = Fax.retrieve "foo"
+      fax.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/faxes/foo"
+    end
+  end
+end

data/test/telnyx/fqdn_connection_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class FQDNConnectionTest < Test::Unit::TestCase
+    should "list fqdn connections" do
+      fqdn_connections = FQDNConnection.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/fqdn_connections"
+      assert_kind_of ListObject, fqdn_connections
+      assert_kind_of FQDNConnection, fqdn_connections.first
+    end
+
+    should "create fqdn connection" do
+      FQDNConnection.create(connection_name: "test")
+      assert_requested :post, "#{Telnyx.api_base}/v2/fqdn_connections"
+    end
+
+    should "retrieve fqdn connection" do
+      fqdn_connection = FQDNConnection.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/fqdn_connections/id"
+      assert_kind_of FQDNConnection, fqdn_connection
+    end
+
+    should "delete fqdn connection" do
+      fqdn_connection = FQDNConnection.retrieve("id")
+
+      fqdn_connection.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/fqdn_connections/id"
+    end
+
+    should "update fqdn connection" do
+      fqdn_connection = FQDNConnection.retrieve("id")
+
+      fqdn_connection.active = false
+      fqdn_connection.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/fqdn_connections/id"
+    end
+  end
+end

data/test/telnyx/fqdn_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class FQDNTest < Test::Unit::TestCase
+    should "list fqdns" do
+      fqdn = FQDN.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/fqdns"
+      assert_kind_of ListObject, fqdn
+      assert_kind_of FQDN, fqdn.first
+    end
+
+    should "create fqdn" do
+      FQDN.create fqdn: "example.com", dns_record_type: "A", connection_id: "abc"
+      assert_requested :post, "#{Telnyx.api_base}/v2/fqdns"
+    end
+
+    should "retrieve fqdn" do
+      fqdn = FQDN.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/fqdns/id"
+      assert_kind_of FQDN, fqdn
+    end
+
+    should "delete fqdn" do
+      fqdn = FQDN.retrieve("id")
+
+      fqdn.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/fqdns/id"
+    end
+
+    should "update fqdn" do
+      fqdn = FQDN.retrieve("id")
+
+      fqdn.fqdn = "example.com"
+      fqdn.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/fqdns/id"
+    end
+  end
+end

data/test/telnyx/ip_connection_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class IPConnectionTest < Test::Unit::TestCase
+    should "list ip connections" do
+      ip_connections = IPConnection.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/ip_connections"
+      assert_kind_of ListObject, ip_connections
+      assert_kind_of IPConnection, ip_connections.first
+    end
+
+    should "create ip connection" do
+      IPConnection.create
+      assert_requested :post, "#{Telnyx.api_base}/v2/ip_connections"
+    end
+
+    should "retrieve ip connection" do
+      ip_connection = IPConnection.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/ip_connections/id"
+      assert_kind_of IPConnection, ip_connection
+    end
+
+    should "delete ip connection" do
+      ip_connection = IPConnection.retrieve("id")
+
+      ip_connection.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/ip_connections/id"
+    end
+
+    should "update ip connection" do
+      ip_connection = IPConnection.retrieve("id")
+
+      ip_connection.active = false
+      ip_connection.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/ip_connections/id"
+    end
+  end
+end

data/test/telnyx/ip_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class IPTest < Test::Unit::TestCase
+    should "list ips" do
+      ip = IP.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/ips"
+      assert_kind_of ListObject, ip
+      assert_kind_of IP, ip.first
+    end
+
+    should "create ip" do
+      IP.create ip_address: "0.0.0.0"
+      assert_requested :post, "#{Telnyx.api_base}/v2/ips"
+    end
+
+    should "retrieve ip" do
+      ip = IP.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/ips/id"
+      assert_kind_of IP, ip
+    end
+
+    should "delete ip" do
+      ip = IP.retrieve("id")
+
+      ip.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/ips/id"
+    end
+
+    should "update ip" do
+      ip = IP.retrieve("id")
+
+      ip.ip_address = "0.0.0.0"
+      ip.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/ips/id"
+    end
+  end
+end

data/test/telnyx/list_object_test.rb

@@ -78,59 +78,6 @@ module Telnyx
       assert_equal expected, actual
     end
 
-    should "provide #auto_paging_each_by_token" do
-      arr = [
-        { id: 1 },
-        { id: 2 },
-        { id: 3 },
-      ]
-      expected = Util.convert_to_telnyx_object(arr, {})
-
-      list = TestListObject.construct_from(data: [{ id: 1 }],
-                                           meta: { next_page_token: "123" },
-                                           url: "/things")
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "123" } })
-        .to_return(body: JSON.generate(data: [{ id: 2 }], meta: { next_page_token: "456" }))
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "456" } })
-        .to_return(body: JSON.generate(data: [{ id: 3 }], meta: { next_page_token: "789" }))
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "789" } })
-        .to_return(body: JSON.generate(data: [], meta: { next_page_token: nil }))
-
-      assert_equal expected, list.auto_paging_each_by_token.to_a
-    end
-
-    should "provide #auto_paging_each_by_token that responds to a block" do
-      arr = [
-        { id: 1 },
-        { id: 2 },
-        { id: 3 },
-      ]
-      expected = Util.convert_to_telnyx_object(arr, {})
-
-      list = TestListObject.construct_from(data: [{ id: 1 }],
-                                           meta: { next_page_token: "123" },
-                                           url: "/things")
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "123" } })
-        .to_return(body: JSON.generate(data: [{ id: 2 }], meta: { next_page_token: "456" }))
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "456" } })
-        .to_return(body: JSON.generate(data: [{ id: 3 }], meta: { next_page_token: "789" }))
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "789" } })
-        .to_return(body: JSON.generate(data: [], meta: { next_page_token: nil }))
-
-      actual = []
-      list.auto_paging_each_by_token do |obj|
-        actual << obj
-      end
-
-      assert_equal expected, actual
-    end
-
     should "provide #empty?" do
       list = Telnyx::ListObject.construct_from(data: [])
       assert list.empty?
@@ -138,6 +85,52 @@ module Telnyx
       refute list.empty?
     end
 
+    #
+    # page_size
+    #
+
+    should "fetch the current page size via #page_size" do
+      list = TestListObject.construct_from(
+        data: [
+          { id: 1 },
+          { id: 2 },
+          { id: 3 },
+        ],
+        meta: {
+          page_size: 5,
+          total_results: 3,
+          total_pages: 1,
+          page_number: 1,
+        },
+        url: "/things"
+      )
+
+      assert_equal(list.page_size, 5)
+    end
+
+    #
+    # page_number
+    #
+
+    should "fetch the current page number via #page_number" do
+      list = TestListObject.construct_from(
+        data: [
+          { id: 1 },
+          { id: 2 },
+          { id: 3 },
+        ],
+        meta: {
+          page_size: 5,
+          total_results: 3,
+          total_pages: 1,
+          page_number: 1,
+        },
+        url: "/things"
+      )
+
+      assert_equal(list.page_number, 1)
+    end
+
     #
     # next_page
     #
@@ -162,7 +155,7 @@ module Telnyx
         .with(query: { page: { number: 2, size: 20 }, enabled: true })
         .to_return(body: JSON.generate(data: [{ id: 2 }], meta: { page_number: 2, total_pages: 2 }))
       next_list = list.next_page
-      assert_equal({ enabled: true }, next_list.filters)
+      assert_equal({ enabled: true, page: { number: 2, size: 20 } }, next_list.filters)
     end
 
     should "fetch an empty page through #next_page" do
@@ -173,41 +166,6 @@ module Telnyx
       assert_equal Telnyx::ListObject.empty_list, next_list
     end
 
-    #
-    # next page by token
-    #
-
-    should "fetch a next page through #next_page_by_token" do
-      list = TestListObject.construct_from(data: [{ id: 1 }],
-                                           meta: { next_page_token: "123" },
-                                           url: "/things")
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "123" } })
-        .to_return(body: JSON.generate(data: [{ id: 2 }]))
-      next_list = list.next_page_by_token
-      refute next_list.empty?
-    end
-
-    should "fetch a next page through #next_page_by_token and respect filters" do
-      list = TestListObject.construct_from(data: [{ id: 1 }],
-                                           meta: { next_page_token: "123" },
-                                           url: "/things")
-      list.filters = { enabled: true }
-      stub_request(:get, "#{Telnyx.api_base}/things")
-        .with(query: { page: { token: "123" }, enabled: true })
-        .to_return(body: JSON.generate(data: [{ id: 2 }], meta: { next_page_token: "456" }))
-      next_list = list.next_page_by_token
-      assert_equal({ enabled: true }, next_list.filters)
-    end
-
-    should "fetch an empty page through #next_page_by_token" do
-      list = TestListObject.construct_from(data: [{ id: 1 }],
-                                           meta: {},
-                                           url: "/things")
-      next_list = list.next_page_by_token
-      assert_equal Telnyx::ListObject.empty_list, next_list
-    end
-
     #
     # previous_page
     #
@@ -234,7 +192,7 @@ module Telnyx
 
       next_list = list.previous_page
       assert_requested(stub_get)
-      assert_equal({ enabled: true }, next_list.filters)
+      assert_equal({ enabled: true, page: { number: 1, size: 20 } }, next_list.filters)
     end
   end
 end