telnyx 0.0.1

data/test/telnyx/list_object_test.rb

@@ -0,0 +1,244 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class ListObjectTest < Test::Unit::TestCase
+    should "provide .empty_list" do
+      list = Telnyx::ListObject.empty_list
+      assert list.empty?
+    end
+
+    should "provide #count via enumerable" do
+      list = Telnyx::ListObject.construct_from(data: [{ record_type: "messaging_profile" }])
+      assert_equal 1, list.count
+    end
+
+    should "provide #each" do
+      arr = [
+        { id: 1 },
+        { id: 2 },
+        { id: 3 },
+      ]
+      expected = Util.convert_to_telnyx_object(arr, {})
+      list = Telnyx::ListObject.construct_from(data: arr)
+      assert_equal expected, list.each.to_a
+    end
+
+    should "provide #auto_paging_each" do
+      arr = [
+        { id: 1 },
+        { id: 2 },
+        { id: 3 },
+      ]
+      expected = Util.convert_to_telnyx_object(arr, {})
+
+      list = TestListObject.construct_from(data: [{ id: 1 }],
+                                           meta: { page_number: 1, total_pages: 4 },
+                                           url: "/things")
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 2, size: 20 } })
+        .to_return(body: JSON.generate(data: [{ id: 2 }], meta: { page_number: 2, total_pages: 4 }))
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 3, size: 20 } })
+        .to_return(body: JSON.generate(data: [{ id: 3 }], meta: { page_number: 3, total_pages: 4 }))
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 4, size: 20 } })
+        .to_return(body: JSON.generate(data: [], meta: { page_number: 4, total_pages: 4 }))
+
+      assert_equal expected, list.auto_paging_each.to_a
+    end
+
+    should "provide #auto_paging_each 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: { page_number: 1, total_pages: 4 },
+                                           url: "/things")
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 2, size: 20 } })
+        .to_return(body: JSON.generate(data: [{ id: 2 }], meta: { page_number: 2, total_pages: 4 }))
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 3, size: 20 } })
+        .to_return(body: JSON.generate(data: [{ id: 3 }], meta: { page_number: 3, total_pages: 4 }))
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 4, size: 20 } })
+        .to_return(body: JSON.generate(data: [], meta: { page_number: 4, total_pages: 4 }))
+
+      actual = []
+      list.auto_paging_each do |obj|
+        actual << obj
+      end
+
+      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?
+      list = Telnyx::ListObject.construct_from(data: [{}])
+      refute list.empty?
+    end
+
+    #
+    # next_page
+    #
+
+    should "fetch a next page through #next_page" do
+      list = TestListObject.construct_from(data: [{ id: 1 }],
+                                           meta: { page_number: 1, total_pages: 2 },
+                                           url: "/things")
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 2, size: 20 } })
+        .to_return(body: JSON.generate(data: [{ id: 2 }]))
+      next_list = list.next_page
+      refute next_list.empty?
+    end
+
+    should "fetch a next page through #next_page and respect filters" do
+      list = TestListObject.construct_from(data: [{ id: 1 }],
+                                           meta: { page_number: 1, total_pages: 2 },
+                                           url: "/things")
+      list.filters = { enabled: true }
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .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)
+    end
+
+    should "fetch an empty page through #next_page" do
+      list = TestListObject.construct_from(data: [{ id: 1 }],
+                                           meta: { page_number: 1, total_pages: 1 },
+                                           url: "/things")
+      next_list = list.next_page
+      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
+    #
+
+    should "fetch a next page through #previous_page" do
+      list = TestListObject.construct_from(data: [{ id: 2 }],
+                                           meta: { page_number: 2, total_pages: 3 },
+                                           url: "/things")
+      stub_request(:get, "#{Telnyx.api_base}/things")
+        .with(query: { page: { number: 1, size: 20 } })
+        .to_return(body: JSON.generate(data: [{ id: 1 }], meta: { page_number: 3, total_pages: 3 }))
+      next_list = list.previous_page
+      refute next_list.empty?
+    end
+
+    should "fetch a next page through #previous_page and respect filters" do
+      list = TestListObject.construct_from(data: [{ id: 2 }],
+                                           meta: { page_number: 2, total_pages: 2 },
+                                           url: "/things")
+      list.filters = { enabled: true }
+      stub_get = stub_request(:get, "#{Telnyx.api_base}/things")
+                 .with(query: { enabled: true, page: { number: 1, size: 20 } })
+                 .to_return(body: JSON.generate(data: [{ id: 1 }], meta: { page_number: 1, total_pages: 2 }))
+
+      next_list = list.previous_page
+      assert_requested(stub_get)
+      assert_equal({ enabled: true }, next_list.filters)
+    end
+  end
+end
+
+# A helper class with a URL that allows us to try out pagination.
+class TestListObject < Telnyx::ListObject
+end

data/test/telnyx/message_test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class MessageTest < Test::Unit::TestCase
+    should "be retrievable" do
+      message = Telnyx::Message.retrieve("123")
+      assert_requested :get, "#{Telnyx.api_base}/v2/messages/123"
+      assert message.is_a?(Telnyx::Message)
+    end
+
+    should "be creatable" do
+      message = Telnyx::Message.create(to: "+18005554000", from: "+18005559000", text: "Hello, World!")
+      assert_requested :post, "#{Telnyx.api_base}/v2/messages"
+      assert message.is_a?(Telnyx::Message)
+    end
+  end
+end

data/test/telnyx/messaging_phone_number_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class MessagingPhoneNumberTest < Test::Unit::TestCase
+    should "be listable" do
+      messaging_phone_numbers = Telnyx::MessagingPhoneNumber.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_phone_numbers"
+      assert messaging_phone_numbers.data.is_a?(Array)
+      assert messaging_phone_numbers.first.is_a?(Telnyx::MessagingPhoneNumber)
+    end
+
+    should "be retrievable" do
+      messaging_phone_number = Telnyx::MessagingPhoneNumber.retrieve("123")
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_phone_numbers/123"
+      assert messaging_phone_number.is_a?(Telnyx::MessagingPhoneNumber)
+    end
+
+    should "be saveable" do
+      messaging_phone_number = Telnyx::MessagingPhoneNumber.retrieve("123")
+      messaging_phone_number.messaging_profile_id = "value"
+      messaging_phone_number.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_phone_numbers/#{messaging_phone_number.id}"
+    end
+
+    should "be updateable" do
+      messaging_phone_number = Telnyx::MessagingPhoneNumber.update("123", messaging_profile_id: "456")
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_phone_numbers/123"
+      assert messaging_phone_number.is_a?(Telnyx::MessagingPhoneNumber)
+    end
+  end
+end

data/test/telnyx/messaging_profile_test.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class MessagingProfileTest < Test::Unit::TestCase
+    should "be listable" do
+      messaging_profiles = Telnyx::MessagingProfile.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_profiles"
+      assert messaging_profiles.data.is_a?(Array)
+      assert messaging_profiles.first.is_a?(Telnyx::MessagingProfile)
+    end
+
+    should "be retrievable" do
+      messaging_profile = Telnyx::MessagingProfile.retrieve("123")
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_profiles/123"
+      assert messaging_profile.is_a?(Telnyx::MessagingProfile)
+    end
+
+    should "be creatable" do
+      messaging_profile = Telnyx::MessagingProfile.create(name: "Foo")
+      assert_requested :post, "#{Telnyx.api_base}/v2/messaging_profiles"
+      assert messaging_profile.is_a?(Telnyx::MessagingProfile)
+    end
+
+    should "be saveable" do
+      messaging_profile = Telnyx::MessagingProfile.retrieve("123")
+      messaging_profile.name = "value"
+      messaging_profile.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_profiles/#{messaging_profile.id}"
+    end
+
+    should "be updateable" do
+      messaging_profile = Telnyx::MessagingProfile.update("123", name: "foo")
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_profiles/123"
+      assert messaging_profile.is_a?(Telnyx::MessagingProfile)
+    end
+
+    should "be deletable" do
+      messaging_profile = Telnyx::MessagingProfile.retrieve("123")
+      messaging_profile = messaging_profile.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/messaging_profiles/#{messaging_profile.id}"
+      assert messaging_profile.is_a?(Telnyx::MessagingProfile)
+    end
+
+    should "be able to list PhoneNumbers" do
+      messaging_profile = Telnyx::MessagingProfile.retrieve("123")
+      phone_numbers = messaging_profile.phone_numbers
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_profiles/123/phone_numbers"
+      assert phone_numbers.data.is_a?(Array)
+      assert phone_numbers.data[0].is_a?(Telnyx::MessagingPhoneNumber)
+    end
+
+    should "be able to list SenderIds" do
+      messaging_profile = Telnyx::MessagingProfile.retrieve("123")
+      sender_ids = messaging_profile.sender_ids
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_profiles/123/sender_ids"
+      assert sender_ids.data.is_a?(Array)
+      assert sender_ids.data[0].is_a?(Telnyx::MessagingSenderId)
+    end
+
+    should "be able to list ShortCodes" do
+      messaging_profile = Telnyx::MessagingProfile.retrieve("123")
+      short_codes = messaging_profile.short_codes
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_profiles/123/short_codes"
+      assert short_codes.data.is_a?(Array)
+      assert short_codes.data[0].is_a?(Telnyx::MessagingShortCode)
+    end
+  end
+end

data/test/telnyx/messaging_sender_id_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class MessagingSenderIdTest < Test::Unit::TestCase
+    should "be listable" do
+      messaging_sender_ids = Telnyx::MessagingSenderId.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_sender_ids"
+      assert messaging_sender_ids.data.is_a?(Array)
+      assert messaging_sender_ids.first.is_a?(Telnyx::MessagingSenderId)
+    end
+
+    should "be retrievable" do
+      messaging_sender_id = Telnyx::MessagingSenderId.retrieve("123")
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_sender_ids/123"
+      assert messaging_sender_id.is_a?(Telnyx::MessagingSenderId)
+    end
+
+    should "be creatable" do
+      messaging_sender_id = Telnyx::MessagingSenderId.create(sender_id: "TelnyxID")
+      assert_requested :post, "#{Telnyx.api_base}/v2/messaging_sender_ids"
+      assert messaging_sender_id.is_a?(Telnyx::MessagingSenderId)
+    end
+
+    should "be saveable" do
+      messaging_sender_id = Telnyx::MessagingSenderId.retrieve("123")
+      messaging_sender_id.messaging_profile_id = "value"
+      messaging_sender_id.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_sender_ids/#{messaging_sender_id.id}"
+    end
+
+    should "be updateable" do
+      messaging_sender_id = Telnyx::MessagingSenderId.update("123", messaging_profile_id: "foo")
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_sender_ids/123"
+      assert messaging_sender_id.is_a?(Telnyx::MessagingSenderId)
+    end
+
+    should "be deletable" do
+      messaging_sender_id = Telnyx::MessagingSenderId.retrieve("123")
+      messaging_sender_id = messaging_sender_id.delete
+      assert_requested :delete, "#{Telnyx.api_base}/v2/messaging_sender_ids/#{messaging_sender_id.id}"
+      assert messaging_sender_id.is_a?(Telnyx::MessagingSenderId)
+    end
+  end
+end

data/test/telnyx/messaging_short_code_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class MessagingShortCodeTest < Test::Unit::TestCase
+    should "be listable" do
+      messaging_short_codes = Telnyx::MessagingShortCode.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_short_codes"
+      assert messaging_short_codes.data.is_a?(Array)
+      assert messaging_short_codes.first.is_a?(Telnyx::MessagingShortCode)
+    end
+
+    should "be retrievable" do
+      messaging_short_code = Telnyx::MessagingShortCode.retrieve("123")
+      assert_requested :get, "#{Telnyx.api_base}/v2/messaging_short_codes/123"
+      assert messaging_short_code.is_a?(Telnyx::MessagingShortCode)
+    end
+
+    should "be saveable" do
+      messaging_short_code = Telnyx::MessagingShortCode.retrieve("123")
+      messaging_short_code.messaging_profile_id = "value"
+      messaging_short_code.save
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_short_codes/#{messaging_short_code.id}"
+    end
+
+    should "be updateable" do
+      messaging_short_code = Telnyx::MessagingShortCode.update("123", messaging_profile_id: "foo")
+      assert_requested :patch, "#{Telnyx.api_base}/v2/messaging_short_codes/123"
+      assert messaging_short_code.is_a?(Telnyx::MessagingShortCode)
+    end
+  end
+end