telnyx 0.0.1

data/telnyx.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(::File.join(::File.dirname(__FILE__), "lib"))
+
+require "telnyx/version"
+
+Gem::Specification.new do |s|
+  s.name = "telnyx"
+  s.version = Telnyx::VERSION
+  s.required_ruby_version = ">= 2.1.0"
+  s.summary = "Ruby bindings for the Telnyx API"
+  s.description = "Telnyx. See https://www.telnyx.com for details."
+  s.author = "Telnyx"
+  s.email = "support@telnyx.com"
+  s.homepage = "https://developers.telnyx.com/docs/api/ruby"
+  s.license = "MIT"
+
+  s.add_dependency("faraday", "~> 0.13")
+  s.add_dependency("net-http-persistent", "~> 3.0")
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| ::File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/api_stub_helpers.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/test/openapi/README.md

@@ -0,0 +1,9 @@
+## Using custom OpenAPI specification and fixtures files
+
+You can place custom OpenAPI specification and fixtures files in this
+directory. The files must be in JSON format, and must be named `spec3.json`
+and `fixtures3.json` respectively.
+
+If those files are present, the test suite will start its own telnyx-mock
+process on a random available port. In order for this to work, `telnyx-mock`
+must be on the `PATH` in the environment used to run the test suite.

data/test/telnyx/api_operations_test.rb

@@ -0,0 +1,85 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class ApiOperationsTest < Test::Unit::TestCase
+    class UpdateableResource < APIResource
+      include Telnyx::APIOperations::Save
+
+      OBJECT_NAME = "updateableresource".freeze
+
+      def self.protected_fields
+        [:protected]
+      end
+    end
+
+    context ".update" do
+      should "patch the correct parameters to the resource URL" do
+        stub_patch = stub_request(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/id")
+                     .with(body: { foo: "bar" })
+                     .to_return(body: JSON.generate(data: { record_type: "messaging_profile", foo: "bar" }))
+        resource = MessagingProfile.update("id", foo: "bar")
+        assert_requested(stub_patch)
+        assert_equal("bar", resource.foo)
+      end
+
+      should "error on protected fields" do
+        e = assert_raises do
+          UpdateableResource.update("id", protected: "bar")
+        end
+        assert_equal "Cannot update protected field: protected", e.message
+      end
+    end
+
+    context ".nested_resource_class_methods" do
+      class MainResource < APIResource
+        extend Telnyx::APIOperations::NestedResource
+        OBJECT_NAME = "mainresource".freeze
+        nested_resource_class_methods :nested,
+                                      operations: %i[create retrieve update delete list]
+      end
+
+      should "define a create method" do
+        stub_request(:post, "#{Telnyx.api_base}/v2/mainresources/id/nesteds")
+          .with(body: { foo: "bar" })
+          .to_return(body: JSON.generate(id: "nested_id", object: "nested", foo: "bar"))
+        nested_resource = MainResource.create_nested("id", foo: "bar")
+        assert_equal "bar", nested_resource.foo
+      end
+
+      should "define a retrieve method" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/mainresources/id/nesteds/nested_id")
+          .to_return(body: JSON.generate(id: "nested_id", object: "nested", foo: "bar"))
+        nested_resource = MainResource.retrieve_nested("id", "nested_id")
+        assert_equal "bar", nested_resource.foo
+      end
+
+      should "define an update method" do
+        stub_patch = stub_request(:patch, "#{Telnyx.api_base}/v2/mainresources/id/nesteds/nested_id")
+                     .with(body: { foo: "baz" })
+                     .to_return(body: JSON.generate(id: "nested_id", object: "nested", foo: "baz"))
+        nested_resource = MainResource.update_nested("id", "nested_id", foo: "baz")
+        assert_requested(stub_patch)
+        assert_equal "baz", nested_resource.foo
+      end
+
+      should "define a delete method" do
+        stub_request(:delete, "#{Telnyx.api_base}/v2/mainresources/id/nesteds/nested_id")
+          .to_return(body: JSON.generate(id: "nested_id", object: "nested", deleted: true))
+        nested_resource = MainResource.delete_nested("id", "nested_id")
+        assert_equal true, nested_resource.deleted
+      end
+
+      should "define a list method" do
+        stub_get = stub_request(:get, "#{Telnyx.api_base}/v2/mainresources/id/nesteds")
+                   .to_return(body: JSON.generate(data: [{ record_type: "foo" }]))
+        nested_resources = MainResource.list_nesteds("id")
+        assert_requested(stub_get)
+        assert nested_resources.is_a?(ListObject)
+        assert nested_resources.data.is_a?(Array)
+      end
+    end
+  end
+end

data/test/telnyx/api_resource_test.rb

@@ -0,0 +1,293 @@
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class ApiResourceTest < Test::Unit::TestCase
+    should "creating a new APIResource should not fetch over the network" do
+      Telnyx::MessagingProfile.new("someid")
+      assert_not_requested :get, %r{#{Telnyx.api_base}/.*}
+    end
+
+    should "creating a new APIResource from a hash should not fetch over the network" do
+      Telnyx::MessagingProfile.construct_from(id: "foo", record_type: "messaging_profile")
+      assert_not_requested :get, %r{#{Telnyx.api_base}/.*}
+    end
+
+    should "setting an attribute should not cause a network request" do
+      m = Telnyx::MessagingProfile.new("123")
+      m.name = "My New Messaging Profile"
+      assert_not_requested :get, %r{#{Telnyx.api_base}/.*}
+      assert_not_requested :post, %r{#{Telnyx.api_base}/.*}
+    end
+
+    should "accessing id should not issue a fetch" do
+      m = Telnyx::MessagingProfile.new("123")
+      m.id
+      assert_not_requested :get, "#{Telnyx.api_base}/messaging_profiles/123"
+    end
+
+    should "not specifying api credentials should raise an exception" do
+      Telnyx.api_key = nil
+      assert_raises Telnyx::AuthenticationError do
+        Telnyx::MessagingProfile.new("456").refresh
+      end
+    end
+
+    should "using a nil api key should raise an exception" do
+      assert_raises TypeError do
+        Telnyx::MessagingProfile.list({}, nil)
+      end
+      assert_raises TypeError do
+        Telnyx::MessagingProfile.list({}, api_key: nil)
+      end
+    end
+
+    should "specifying api credentials containing whitespace should raise an exception" do
+      Telnyx.api_key = "key "
+      assert_raises Telnyx::AuthenticationError do
+        Telnyx::MessagingProfile.new("123").refresh
+      end
+    end
+
+    should "get resource URL" do
+      m = Telnyx::MessagingProfile.new("123")
+      assert_match "/messaging_profiles/123", m.resource_url
+    end
+
+    context "when specifying per-object credentials" do
+      context "with no global API key set" do
+        should "use the per-object credential when creating" do
+          stub_post = stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")
+                      .with(headers: { "Authorization" => "Bearer super-secret" })
+                      .to_return(body: JSON.generate(data: messaging_profile_fixture))
+
+          Telnyx::MessagingProfile.create({ name: "New Messaging Profile" },
+                                          "super-secret")
+          assert_requested(stub_post)
+        end
+      end
+
+      context "with a global API key set" do
+        setup do
+          Telnyx.api_key = "global"
+        end
+
+        teardown do
+          Telnyx.api_key = nil
+        end
+
+        should "use the per-object credential when creating" do
+          stub_post = stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")
+                      .with(headers: { "Authorization" => "Bearer super-secret" })
+                      .to_return(body: JSON.generate(data: messaging_profile_fixture))
+
+          Telnyx::MessagingProfile.create({ name: "New Messaging Profile" },
+                                          "super-secret")
+          assert_requested(stub_post)
+        end
+      end
+    end
+
+    context "with valid credentials" do
+      should "urlencode values in GET params" do
+        stub_get = stub_request(:get, "#{Telnyx.api_base}/v2/messaging_profiles")
+                   .with(query: { page: { size: 10 } })
+                   .to_return(body: JSON.generate(data: [messaging_profile_fixture]))
+        messaging_profiles = Telnyx::MessagingProfile.list(page: { size: 10 }).data
+        assert messaging_profiles.is_a? Array
+        assert_requested(stub_get)
+      end
+
+      should "setting a nil value for a param should exclude that param from the request" do
+        stub_get = stub_request(:get, "#{Telnyx.api_base}/v2/messaging_profiles")
+                   .with(query: { page: { size: 5 }, sad: false })
+                   .to_return(body: JSON.generate(data: [messaging_profile_fixture]))
+        Telnyx::MessagingProfile.list(count: nil, page: { size: 5 }, sad: false)
+
+        assert_requested(stub_get)
+
+        Telnyx::MessagingProfile.create(name: nil, foo: "bar")
+
+        assert_requested(:post, "#{Telnyx.api_base}/v2/messaging_profiles", body: { "foo" => "bar" })
+      end
+
+      should "requesting with a unicode ID should result in a request" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/messaging_profiles/%E2%98%83")
+          .to_return(body: JSON.generate(make_resource_not_found_error), status: 404)
+        mp = Telnyx::MessagingProfile.new("☃")
+        assert_raises(Telnyx::ResourceNotFoundError) { mp.refresh }
+      end
+
+      should "requesting with no ID should result in an InvalidRequestError with no request" do
+        mp = Telnyx::MessagingProfile.new
+        assert_raises(Telnyx::InvalidRequestError) { mp.refresh }
+      end
+
+      should "making a GET request with parameters should have a query string and no body" do
+        stub = stub_request(:get, "#{Telnyx.api_base}/v2/messaging_profiles")
+               .with(query: { limit: 1 })
+               .to_return(body: JSON.generate(data: [messaging_profile_fixture]))
+        Telnyx::MessagingProfile.list(limit: 1)
+        assert_requested(stub, body: "")
+      end
+
+      should "making a POST request with parameters should have a body and no query string" do
+        Telnyx::MessagingProfile.create(name: "New Messaging Profile")
+        assert_requested(:post, "#{Telnyx.api_base}/v2/messaging_profiles", body: { name: "New Messaging Profile" })
+      end
+
+      should "loading an object should issue a GET request" do
+        mp = Telnyx::MessagingProfile.new("123")
+        mp.refresh
+        assert_requested(:get, "#{Telnyx.api_base}/v2/messaging_profiles/123")
+      end
+
+      should "using array accessors should be the same as the method interface" do
+        mp = Telnyx::MessagingProfile.new("123")
+        mp.refresh
+        assert_equal mp.created_at, mp[:created_at]
+        assert_equal mp.created_at, mp["created_at"]
+        mp["created_at"] = 12_345
+        assert_equal mp.created_at, 12_345
+        assert_requested(:get, "#{Telnyx.api_base}/v2/messaging_profiles/123")
+      end
+
+      should "updating an object should issue a PATCH request with only the changed properties" do
+        mp = Telnyx::MessagingProfile.construct_from(messaging_profile_fixture)
+        mp.name = "new name"
+        mp.save
+        assert_requested(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/123", body: { "name" => "new name" })
+      end
+
+      should "updating should merge in returned properties" do
+        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.simplify_characters
+      end
+
+      should "updating should fail if api_key is overwritten with nil" do
+        mp = Telnyx::MessagingProfile.new
+        assert_raises TypeError do
+          mp.save({}, api_key: nil)
+        end
+      end
+
+      should "updating should use the supplied api_key" do
+        stub_post = stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")
+                    .with(headers: { "Authorization" => "Bearer super-secret" })
+                    .to_return(body: JSON.generate(data: messaging_profile_fixture))
+        mp = Telnyx::MessagingProfile.new
+        mp.save({ name: "Profile for Messages" }, api_key: "super-secret")
+
+        assert_requested(stub_post)
+        assert_equal "Profile for Messages", mp.name
+      end
+
+      should "deleting should send no props and result in an object that has no props other than `deleted`" do
+        mp = Telnyx::MessagingProfile.construct_from(messaging_profile_fixture)
+        mp.delete
+        assert_requested(:delete, "#{Telnyx.api_base}/v2/messaging_profiles/123", body: "")
+      end
+
+      should "loading all of an APIResource should return an array of recursively instantiated objects" do
+        messaging_profiles = Telnyx::MessagingProfile.list.data
+
+        assert_requested(:get, "#{Telnyx.api_base}/v2/messaging_profiles")
+        assert messaging_profiles.is_a? Array
+        assert messaging_profiles[0].is_a? Telnyx::MessagingProfile
+      end
+
+      should "save nothing if nothing changes" do
+        messaging_profile = Telnyx::MessagingProfile.construct_from(
+          id: "123",
+          meta: {
+            key: "value",
+          }
+        )
+
+        messaging_profile.save
+        assert_requested(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/123", body: {})
+      end
+
+      should "correctly handle array noops" do
+        messaging_profile = Telnyx::MessagingProfile.construct_from(
+          id: "myid",
+          legal_entity: {
+            additional_owners: [{ first_name: "Bob" }],
+          },
+          currencies_supported: %w[usd cad]
+        )
+
+        messaging_profile.save
+        assert_requested(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/myid", body: {})
+      end
+
+      should "correctly handle hash noops" do
+        messaging_profile = Telnyx::MessagingProfile.construct_from(
+          id: "myid",
+          legal_entity: {
+            address: { line1: "1 Two Three" },
+          }
+        )
+
+        stub_post = stub_request(:patch, "#{Telnyx.api_base}/v2/messaging_profiles/myid")
+                    .with(body: {})
+                    .to_return(body: JSON.generate(data: { "id" => "myid" }))
+
+        messaging_profile.save
+        assert_requested(stub_post)
+      end
+
+      should "should create a new resource when an object without an id is saved" do
+        messaging_profile = Telnyx::MessagingProfile.construct_from(id: nil, name: nil)
+
+        messaging_profile.name = "my-messaging-profile"
+        messaging_profile.save
+
+        assert_requested(:post, "#{Telnyx.api_base}/v2/messaging_profiles", body: { name: "my-messaging-profile" })
+      end
+
+      should "set attributes as part of save" do
+        messaging_profile = Telnyx::MessagingProfile.construct_from(id: nil,
+                                                                    name: nil)
+
+        stub_post = stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")
+                    .with(body: { name: "telnyx", meta: { key: "value" } })
+                    .to_return(body: JSON.generate(data: { "id" => "123" }))
+
+        messaging_profile.save(name: "telnyx", meta: { key: "value" })
+        assert_requested(stub_post)
+      end
+    end
+
+    @@fixtures = {}
+    setup do
+      if @@fixtures.empty?
+        cache_fixture(:messaging_profile) do
+          MessagingProfile.retrieve("123")
+        end
+      end
+    end
+
+    private
+
+    def messaging_profile_fixture
+      @@fixtures[:messaging_profile]
+    end
+
+    # Expects to retrieve a fixture from telnyx-mock (an API call should be
+    # included in the block to yield to) and does very simple memoization.
+    def cache_fixture(key)
+      return @@fixtures[key] if @@fixtures.key?(key)
+
+      obj = yield
+      @@fixtures[key] = obj.instance_variable_get(:@values).freeze
+      @@fixtures[key]
+    end
+  end
+end

data/test/telnyx/available_phone_number_test.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class AvailablePhoneNumberTest < Test::Unit::TestCase
+    should "be listable" do
+      available_phone_numbers = Telnyx::AvailablePhoneNumber.list
+      assert_requested :get, "#{Telnyx.api_base}/v2/available_phone_numbers"
+      assert available_phone_numbers.data.is_a?(Array)
+      assert available_phone_numbers.first.is_a?(Telnyx::AvailablePhoneNumber)
+    end
+  end
+end

data/test/telnyx/errors_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../../test_helper", __FILE__)
+
+module Telnyx
+  class TelnyxErrorTest < Test::Unit::TestCase
+    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
+
+        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
+
+        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
+
+        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
+      end
+    end
+  end
+end