telnyx 0.0.7 → 2.4.0

data/lib/telnyx/util.rb

@@ -39,18 +39,42 @@ module Telnyx
     def self.object_classes
       @object_classes ||= {
         # business objects
-        AlphanumericSenderId::OBJECT_NAME       => AlphanumericSenderId,
-        AvailablePhoneNumber::OBJECT_NAME       => AvailablePhoneNumber,
-        Call::OBJECT_NAME                       => Call,
-        Conferences::OBJECT_NAME                => Conferences,
-        Message::OBJECT_NAME                    => Message,
-        MessagingPhoneNumber::OBJECT_NAME       => MessagingPhoneNumber,
-        MessagingProfile::OBJECT_NAME           => MessagingProfile,
-        NumberOrder::OBJECT_NAME                => NumberOrder,
-        NumberReservation::OBJECT_NAME          => NumberReservation,
-        PublicKey::OBJECT_NAME                  => PublicKey,
-        PhoneNumber::OBJECT_NAME                => PhoneNumber,
-        SimCard::OBJECT_NAME                    => SimCard,
+        Address::OBJECT_NAME                          => Address,
+        AlphanumericSenderId::OBJECT_NAME             => AlphanumericSenderId,
+        AvailablePhoneNumber::OBJECT_NAME             => AvailablePhoneNumber,
+        BillingGroup::OBJECT_NAME                     => BillingGroup,
+        Call::OBJECT_NAME                             => Call,
+        CallControlApplication::OBJECT_NAME           => CallControlApplication,
+        Conferences::OBJECT_NAME                      => Conferences,
+        Connection::OBJECT_NAME                       => Connection,
+        CredentialConnection::OBJECT_NAME             => CredentialConnection,
+        Fax::OBJECT_NAME                              => Fax,
+        FaxApplication::OBJECT_NAME                   => FaxApplication,
+        FQDN::OBJECT_NAME                             => FQDN,
+        FQDNConnection::OBJECT_NAME                   => FQDNConnection,
+        IP::OBJECT_NAME                               => IP,
+        IPConnection::OBJECT_NAME                     => IPConnection,
+        Message::OBJECT_NAME                          => Message,
+        MessagingPhoneNumber::OBJECT_NAME             => MessagingPhoneNumber,
+        "messaging_settings"                          => MessagingPhoneNumber,
+        MessagingProfile::OBJECT_NAME                 => MessagingProfile,
+        NumberLookup::OBJECT_NAME                     => NumberLookup,
+        NumberOrder::OBJECT_NAME                      => NumberOrder,
+        NumberOrderDocument::OBJECT_NAME              => NumberOrderDocument,
+        NumberReservation::OBJECT_NAME                => NumberReservation,
+        OutboundVoiceProfile::OBJECT_NAME             => OutboundVoiceProfile,
+        PhoneNumber::OBJECT_NAME                      => PhoneNumber,
+        "phone_number_reservation"                    => NumberReservation,
+        PhoneNumberRegulatoryRequirement::OBJECT_NAME => PhoneNumberRegulatoryRequirement,
+        "phone_number_regulatory_group"               => PhoneNumberRegulatoryRequirement,
+        Portout::OBJECT_NAME                          => Portout,
+        VerifyProfile::OBJECT_NAME                    => VerifyProfile,
+        PublicKey::OBJECT_NAME                        => PublicKey,
+        RegulatoryRequirement::OBJECT_NAME            => RegulatoryRequirement,
+        SimCard::OBJECT_NAME                          => SimCard,
+        Verification::OBJECT_NAME                     => Verification,
+        "verification"                                => Verification::Response,
+        WirelessDetailRecordsReport::OBJECT_NAME      => WirelessDetailRecordsReport,
       }
     end
 
@@ -68,7 +92,7 @@ module Telnyx
     #
     # ==== Attributes
     #
-    # * +data+ - Hash of fields and values to be converted into a TelnyxObject.
+    # * +Data+ - Hash of fields and values to be converted into a TelnyxObject.
     # * +opts+ - Options for +TelnyxObject+ like an API key that will be reused
     #   on subsequent API calls.
     def self.convert_to_telnyx_object(data, opts = {})
@@ -79,7 +103,7 @@ module Telnyx
         # Try converting to a known object class. If none available, fall back to generic TelnyxObject
         if data[:data].is_a?(Array)
           ListObject.construct_from(data, opts)
-        elsif data[:data] && data[:data][:record_type]
+        elsif data[:data].is_a?(Hash) && data[:data][:record_type]
           object_classes.fetch(data[:data][:record_type], TelnyxObject).construct_from(data[:data], opts)
         elsif data[:record_type]
           object_classes.fetch(data[:record_type], TelnyxObject).construct_from(data, opts)

data/lib/telnyx/verification.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class Verification < APIResource
+    # Type for verification responses
+    class Response < TelnyxObject; end
+
+    extend APIOperations::Create
+    extend APIOperations::NestedResource
+
+    nested_resource_class_methods "by_telephone",
+                                  path: "by_tn",
+                                  operations: [:retrieve],
+                                  instance_methods: {
+                                    retrieve: "by_telephone",
+                                  }
+
+    def self.submit_code(phone_number: nil, code: nil)
+      url = "#{resource_url}/by_phone_number/#{CGI.escape phone_number}/actions/verify"
+      resp, _opts = request(:post, url, code: code)
+      Response.construct_from resp.data[:data]
+    end
+
+    OBJECT_NAME = "verify_verification".freeze
+    RESOURCE_PATH = "verifications".freeze
+  end
+end

data/lib/telnyx/verify_profile.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class VerifyProfile < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Save
+
+    OBJECT_NAME = "verify_profile".freeze
+  end
+end

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "0.0.7".freeze
+  VERSION = "2.4.0".freeze
 end

data/lib/telnyx/wireless_detail_records_report.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class WirelessDetailRecordsReport < APIResource
+    include APIOperations::Delete
+    extend APIOperations::List
+    extend APIOperations::Create
+
+    OBJECT_NAME = "detail_records_report".freeze
+    RESOURCE_PATH = "wireless/detail_records_reports".freeze
+  end
+end

data/telnyx.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "source_code_uri"   => "https://github.com/team-telnyx/telnyx-ruby",
   }
 
-  s.add_dependency("faraday", "~> 0.13", "!= 0.16.0", "!= 0.16.1", "!= 0.16.2")
+  s.add_dependency("faraday", "~> 0.13", "!= 0.16.0", "!= 0.16.1", "!= 0.16.2", "!= 0.17.1")
   s.add_dependency("net-http-persistent", "~> 3.0")
   s.add_dependency("ed25519", "~> 1")
 

data/test/telnyx/address_test.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class AddressTest < Test::Unit::TestCase
+    should "list addresses" do
+      stub = stub_request(:get, "#{Telnyx.api_base}/v2/addresses")
+             .to_return(body: JSON.generate(data: [FIXTURE]))
+      addresses = Address.list
+      # assert_requested :get, "#{Telnyx.api_base}/v2/addresses"
+      assert_requested stub
+      assert_kind_of ListObject, addresses
+      assert_kind_of Address, addresses.first
+    end
+
+    should "create address" do
+      stub = stub_request(:post, "#{Telnyx.api_base}/v2/addresses")
+             .to_return(body: JSON.generate(data: FIXTURE))
+      address = Address.create
+      # assert_requested :post, "#{Telnyx.api_base}/v2/addresses"
+      assert_requested stub
+      assert_kind_of Address, address
+    end
+
+    should "retrieve address" do
+      stub = stub_request(:get, "#{Telnyx.api_base}/v2/addresses/id")
+             .to_return(body: JSON.generate(data: FIXTURE))
+      address = Address.retrieve("id")
+      # assert_requested :get, "#{Telnyx.api_base}/v2/addresses/id"
+      assert_requested stub
+      assert_kind_of Address, address
+    end
+
+    should "delete address" do
+      stub_request(:get, "#{Telnyx.api_base}/v2/addresses/id")
+        .to_return(body: JSON.generate(data: FIXTURE))
+      stub = stub_request(:delete, "#{Telnyx.api_base}/v2/addresses/id")
+             .to_return(body: JSON.generate(data: FIXTURE))
+      address = Address.retrieve("id")
+
+      address.delete
+      # assert_requested :delete, "#{Telnyx.api_base}/v2/addresses/id"
+      assert_requested stub
+    end
+
+    FIXTURE = {
+      "address_book" => false,
+      "administrative_area" => "IL",
+      "borough" => "Guadalajara",
+      "business_name" => "Toy-O'Kon",
+      "country_code" => "us",
+      "created_at" => "2018-02-02T22:25:27.521Z",
+      "extended_address" => "Suite 123",
+      "first_name" => "Alfred",
+      "id" => "id",
+      "last_name" => "Foster",
+      "locality" => "Chicago",
+      "neighborhood" => "Ciudad de los deportes",
+      "phone_number" => "+12125559000",
+      "postal_code" => 2904,
+      "record_type" => "address",
+      "street_address" => "457 Flatley Stream",
+      "updated_at" => "2018-02-02T22:25:27.521Z",
+    }.freeze
+  end
+end

data/test/telnyx/alphanumeric_sender_id_test.rb

@@ -4,6 +4,10 @@ require ::File.expand_path("../../test_helper", __FILE__)
 
 module Telnyx
   class AlphanumericSenderIdTest < Test::Unit::TestCase
+    setup do
+      omit "alphanumeric ids mock spec removed"
+    end
+
     should "be listable" do
       alphanumeric_sender_ids = Telnyx::AlphanumericSenderId.list
       assert_requested :get, "#{Telnyx.api_base}/v2/alphanumeric_sender_ids"

data/test/telnyx/api_resource_test.rb

@@ -108,9 +108,12 @@ module Telnyx
 
         assert_requested(stub_get)
 
+        stub_get = stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")
+                   .with(body: { "foo" => "bar" })
+                   .to_return(body: JSON.generate(data: [messaging_profile_fixture]))
         Telnyx::MessagingProfile.create(name: nil, foo: "bar")
 
-        assert_requested(:post, "#{Telnyx.api_base}/v2/messaging_profiles", body: { "foo" => "bar" })
+        assert_requested stub_get
       end
 
       should "requesting with a unicode ID should result in a request" do
@@ -155,19 +158,25 @@ module Telnyx
       end
 
       should "updating an object should issue a PATCH request with only the changed properties" do
-        mp = Telnyx::MessagingProfile.construct_from(messaging_profile_fixture)
+        stub_patch = stub_request(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/123")
+                     .with(body: hash_including("name" => "new name"))
+                     .to_return(body: JSON.generate(data: messaging_profile_fixture))
+        mp = Telnyx::MessagingProfile.retrieve("123")
         mp.name = "new name"
         mp.save
-        assert_requested(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/123", body: { "name" => "new name" })
+        assert_requested(stub_patch)
       end
 
       should "updating should merge in returned properties" do
+        stub_patch = stub_request(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/123")
+                     .with(body: hash_including("name" => "new name"))
+                     .to_return(body: JSON.generate(data: messaging_profile_fixture))
         mp = Telnyx::MessagingProfile.new("123")
         mp.name = "new name"
         mp.save
 
-        assert_requested(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/123", body: { "name" => "new name" })
-        assert mp.name == "new name"
+        assert_requested(stub_patch)
+        assert mp
       end
 
       should "updating should fail if api_key is overwritten with nil" do

data/test/telnyx/billing_group_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class BillingGroupTest < Test::Unit::TestCase
+    should "list billing groups" do
+      billing_groups = BillingGroup.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/billing_groups"
+      assert_kind_of ListObject, billing_groups
+      assert_kind_of BillingGroup, billing_groups.first
+    end
+
+    should "create billing group" do
+      BillingGroup.create
+      assert_requested :post, "#{Telnyx.api_base}/v2/billing_groups"
+    end
+
+    should "retrieve billing group" do
+      billing_group = BillingGroup.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/billing_groups/id"
+      assert_kind_of BillingGroup, billing_group
+    end
+
+    should "delete billing group" do
+      billing_group = BillingGroup.retrieve("id")
+
+      billing_group.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/billing_groups/id"
+    end
+
+    should "update billing group" do
+      billing_group = BillingGroup.retrieve("id")
+
+      billing_group.active = false
+      billing_group.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/billing_groups/id"
+    end
+  end
+end

data/test/telnyx/call_control_application_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class CallControlApplicationTest < Test::Unit::TestCase
+    should "list call_control_application" do
+      call_control_application = CallControlApplication.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/call_control_applications"
+      assert_kind_of ListObject, call_control_application
+      assert_kind_of CallControlApplication, call_control_application.first
+    end
+
+    should "create call_control_application" do
+      CallControlApplication.create webhook_event_url: "example.com", connection_name: "telnyx", application_name: "telnyx"
+      assert_requested :post, "#{Telnyx.api_base}/v2/call_control_applications"
+    end
+
+    should "retrieve call_control_application" do
+      call_control_application = CallControlApplication.retrieve("id")
+      assert_requested :get, "#{Telnyx.api_base}/v2/call_control_applications/id"
+      assert_kind_of CallControlApplication, call_control_application
+    end
+
+    should "delete call_control_application" do
+      call_control_application = CallControlApplication.retrieve("id")
+
+      call_control_application.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/call_control_applications/id"
+    end
+
+    should "update call_control_application" do
+      call_control_application = CallControlApplication.retrieve("id")
+
+      call_control_application.webhook_event_url = "example.com"
+      call_control_application.connection_name = "telnyx"
+      call_control_application.application_name = "telnyx"
+      call_control_application.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/call_control_applications/id"
+    end
+  end
+end

data/test/telnyx/call_control_test.rb

@@ -66,7 +66,7 @@ module Telnyx
       should "send all commands" do
         @call = Call.new
         @call.id = "1234"
-        @call.reject
+        @call.reject cause: "CALL_REJECTED"
         assert_requested :post, format_url(@call, "reject")
         @call.answer
         assert_requested :post, format_url(@call, "answer")
@@ -97,7 +97,7 @@ module Telnyx
 
     context "commands" do
       should "reject" do
-        @call.reject
+        @call.reject cause: "CALL_REJECTED"
         assert_requested :post, format_url(@call, "reject")
       end
       should "answer" do
@@ -151,7 +151,7 @@ module Telnyx
     end
 
     def create_call
-      Telnyx::Call.create connection_id: "12345", to: "+15550001111", from: "+15550002222"
+      Telnyx::Call.create connection_id: "12345", to: "+15550001111", from: "+15550002222", cause: "test"
     end
 
     def format_url(call, action)

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