telnyx 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab5e38d59a795014bb8cd179a7b2d621730070a140fb0a089c8bd873be92cf3
-  data.tar.gz: 1070f9b6389bb74a793c47e0926533a69cf188859e8fb21c5d10e9224e1c5b75
+  metadata.gz: 954fc20c0162c4c8d7a2a4452e5d892b1ab4a46b2cb080af7b4fd3d4d9fed258
+  data.tar.gz: afac25a5c6384f6ad5aacefacbfa0a6eb5927a8d19744865eba79328e9560108
 SHA512:
-  metadata.gz: 16eb703601a65504320838551bdec62e07014a015e4817d5fa8a372e3d24cc35bd5ba8f2a583b8c015379bda0754a09e9d54776fe7e0fd893d60fc17db590f55
-  data.tar.gz: '08351961080c07cffe34d3d882b6a1b0df5013a37a6e19092ddd9579eb7ce6246f9f3fbcfbc92d11c180fabe561ae15c841c8513ed9917c66f8bfec62e034775'
+  metadata.gz: e284d6bf79df563365f76e9355dc7009e58bbbcbb984f440e45bdf55d297fdbb9b742484418dec64de4d5a99c86b626fec113093a83d02f39f2f65d11a0a813f
+  data.tar.gz: 6a233a3042db655c72511203c9e79d3b1b80ae64b3ec38dacf5c1b31a8c3ee417291428ce57a3b7c2d9e35ba3b0a81ad66529a781322937da044eb0bb26fa2c7

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/telnyx.rb

@@ -46,7 +46,9 @@ require "telnyx/messaging_phone_number"
 require "telnyx/messaging_profile"
 require "telnyx/number_order"
 require "telnyx/number_reservation"
+require "telnyx/phone_number"
 require "telnyx/public_key"
+require "telnyx/sim_card.rb"
 
 module Telnyx
   @app_info = nil

data/lib/telnyx/api_operations/nested_resource.rb

@@ -6,11 +6,12 @@ module Telnyx
     # that it's possible to do so from a static context (i.e. without a
     # pre-existing collection of subresources on the parent).
     #
-    # For examle, a transfer gains the static methods for reversals so that the
+    # For example, a transfer gains the static methods for reversals so that the
     # methods `.create_reversal`, `.retrieve_reversal`, `.update_reversal`,
     # etc. all become available.
     # rubocop:disable  Metrics/AbcSize
     # rubocop:disable  Metrics/MethodLength
+    # rubocop:disable  Metrics/CyclomaticComplexity
     module NestedResource
       def nested_resource_class_methods(resource, path: nil, operations: nil, instance_methods: {})
         path ||= "#{resource}s"
@@ -29,8 +30,19 @@ module Telnyx
         define_instance_method = lambda do |target_name, operation|
           return unless instance_methods.keys.include? operation
 
-          define_method(instance_methods[operation] || target_name) do |*opts|
-            self.class.send(target_name, id, *opts)
+          case operation
+          when :create, :list
+            define_method(instance_methods[operation] || target_name) do |*opts|
+              self.class.send(target_name, id, *opts)
+            end
+          when :retrieve
+            define_method(instance_methods[operation] || target_name) do |nested_id|
+              self.class.send(target_name, id, nested_id)
+            end
+          when :update, :delete
+            define_method(instance_methods[operation] || target_name) do |nested_id, *opts|
+              self.class.send(target_name, id, nested_id, *opts)
+            end
           end
         end
 

data/lib/telnyx/phone_number.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class PhoneNumber < APIResource
+    include Telnyx::APIOperations::Save
+    include Telnyx::APIOperations::Delete
+    extend Telnyx::APIOperations::List
+    extend Telnyx::APIOperations::NestedResource
+
+    nested_resource_class_methods "voice",
+                                  path: ["voice"],
+                                  operations: %i[update list],
+                                  instance_methods: { list: "voice" }
+    nested_resource_class_methods "messaging",
+                                  path: ["messaging"],
+                                  operations: %i[update list],
+                                  instance_methods: { list: "messaging" }
+
+    def update_messaging(opts)
+      self.class.update_messaging(id, nil, opts)
+    end
+
+    def update_voice(opts)
+      self.class.update_voice(id, nil, opts)
+    end
+
+    OBJECT_NAME = "phone_number".freeze
+  end
+end

data/lib/telnyx/sim_card.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class SimCard < APIResource
+    include Telnyx::APIOperations::Save
+    extend APIOperations::NestedResource
+    extend APIOperations::List
+
+    ACTIONS = %w[deactivate activate].freeze
+    ACTIONS.each do |action|
+      nested_resource_class_methods action,
+                                    path: %W[actions #{action}],
+                                    operations: [:create],
+                                    instance_methods: { create: action }
+    end
+
+    OBJECT_NAME = "sim_card".freeze
+  end
+end

data/lib/telnyx/telnyx_response.rb

@@ -26,7 +26,7 @@ module Telnyx
     # This may throw JSON::ParserError if the response body is not valid JSON.
     def self.from_faraday_hash(http_resp)
       resp = TelnyxResponse.new
-      resp.data = JSON.parse(http_resp[:body], symbolize_names: true)
+      resp.data = JSON.parse(preprocess_response(http_resp[:body]), symbolize_names: true)
       resp.http_body = http_resp[:body]
       resp.http_headers = http_resp[:headers]
       resp.http_status = http_resp[:status]
@@ -39,12 +39,21 @@ module Telnyx
     # This may throw JSON::ParserError if the response body is not valid JSON.
     def self.from_faraday_response(http_resp)
       resp = TelnyxResponse.new
-      resp.data = JSON.parse(http_resp.body, symbolize_names: true)
+      resp.data = JSON.parse(preprocess_response(http_resp.body), symbolize_names: true)
       resp.http_body = http_resp.body
       resp.http_headers = http_resp.headers
       resp.http_status = http_resp.status
       resp.request_id = http_resp.headers["X-Request-Id"]
       resp
     end
+
+    class << self
+      private
+
+      # Helper to handle when the server responds with a blank body (as is the case with SimCards).
+      def preprocess_response(resp)
+        resp.empty? ? "{}" : resp
+      end
+    end
   end
 end

data/lib/telnyx/util.rb

@@ -49,6 +49,8 @@ module Telnyx
         NumberOrder::OBJECT_NAME                => NumberOrder,
         NumberReservation::OBJECT_NAME          => NumberReservation,
         PublicKey::OBJECT_NAME                  => PublicKey,
+        PhoneNumber::OBJECT_NAME                => PhoneNumber,
+        SimCard::OBJECT_NAME                    => SimCard,
       }
     end
 

data/lib/telnyx/version.rb

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

data/test/telnyx/phone_number_test.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+module Telnyx
+  class PhoneNumberTest < Test::Unit::TestCase
+    should "list resources" do
+      stub = stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers")
+             .to_return(body: JSON.generate(data: (1..5).map { |i| mock_response(i) }))
+      phone_numbers = Telnyx::PhoneNumber.list
+      assert_requested stub
+      assert_kind_of Telnyx::ListObject, phone_numbers
+      assert_kind_of Telnyx::PhoneNumber, phone_numbers.first
+    end
+
+    should "get resource" do
+      stub = stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123")
+             .to_return(body: JSON.generate(data: mock_response("123")))
+      phone_number = Telnyx::PhoneNumber.retrieve("123")
+      assert_kind_of Telnyx::PhoneNumber, phone_number
+      assert_requested stub
+      assert_equal phone_number.id, "123"
+    end
+
+    should "update resource" do
+      stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123")
+        .to_return(body: JSON.generate(data: mock_response("123")))
+      stub = stub_request(:patch, "#{Telnyx.api_base}/v2/phone_numbers/123")
+             .to_return(body: JSON.generate(data: mock_response("123")))
+      phone_number = Telnyx::PhoneNumber.retrieve("123")
+      phone_number.save
+      assert_requested stub
+    end
+
+    should "delete resource" do
+      stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123")
+        .to_return(body: JSON.generate(data: mock_response("123")))
+      stub = stub_request(:delete, "#{Telnyx.api_base}/v2/phone_numbers/123")
+             .to_return(body: JSON.generate(data: mock_response("123")))
+      phone_number = Telnyx::PhoneNumber.retrieve("123")
+      phone_number.delete
+      assert_requested stub
+    end
+
+    context "nested commands" do
+      should "update voice" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123")
+          .to_return(body: JSON.generate(data: mock_response("123")))
+        command_stub = stub_request(:patch, "#{Telnyx.api_base}/v2/phone_numbers/123/voice")
+                       .with(body: { connection_id: 123 })
+                       .to_return(body: JSON.generate(data: mock_voice_response))
+        phone_number = Telnyx::PhoneNumber.retrieve("123")
+        phone_number.update_voice(connection_id: 123)
+        assert_requested command_stub
+      end
+
+      should "get voice" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123")
+          .to_return(body: JSON.generate(data: mock_response("123")))
+        command_stub = stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123/voice")
+                       .to_return(body: JSON.generate(data: mock_voice_response("456")))
+        phone_number = Telnyx::PhoneNumber.retrieve("123")
+        voice = phone_number.voice
+        assert_requested command_stub
+        assert_equal voice.data.connection_id, "456"
+      end
+
+      should "get messaging" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123")
+          .to_return(body: JSON.generate(data: mock_response("123")))
+        command_stub = stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123/messaging")
+                       .to_return(body: JSON.generate(data: mock_messaging_response("456")))
+        phone_number = Telnyx::PhoneNumber.retrieve("123")
+        phone_number.messaging
+        assert_requested command_stub
+      end
+
+      should "update messaging" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/phone_numbers/123")
+          .to_return(body: JSON.generate(data: mock_response("123")))
+        command_stub = stub_request(:patch, "#{Telnyx.api_base}/v2/phone_numbers/123/messaging")
+                       .with(body: { messaging_profile_id: "12345", messaging_product: "P2P" })
+                       .to_return(body: JSON.generate(data: mock_messaging_response))
+        phone_number = Telnyx::PhoneNumber.retrieve("123")
+        phone_number.update_messaging(messaging_profile_id: "12345", messaging_product: "P2P")
+        assert_requested command_stub
+      end
+    end
+
+    def mock_response(id = nil)
+      {
+        id: (id || rand(0...1_000_000_000_000)),
+        record_type: :phone_number,
+        status: rand(1..10),
+        phone_number: "+15555555555",
+        address_id: rand(0...1_000_000_000_000),
+      }
+    end
+
+    def mock_voice_response(id = nil)
+      {
+        connection_id: (id || rand(0...1_000_000_000_000)),
+        connection_name: "Telnyx connection",
+      }
+    end
+
+    def mock_messaging_response(_id = nil)
+      {
+        record_type: "messaging_phone_number",
+        phone_number: "+18005550001",
+        id: "+18665550001",
+      }
+    end
+  end
+end

data/test/telnyx/sim_card_test.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+module Telnyx
+  class SimCardTest < Test::Unit::TestCase
+    should "retrieve sim card" do
+      stub = stub_request(:get, "#{Telnyx.api_base}/v2/sim_cards/123")
+             .to_return(body: JSON.generate(data: { record_type: "sim_card", id: "123" }))
+      sim = Telnyx::SimCard.retrieve "123"
+      assert_requested stub
+      assert_kind_of Telnyx::SimCard, sim
+    end
+
+    should "list sim cards" do
+      stub = stub_request(:get, "#{Telnyx.api_base}/v2/sim_cards")
+             .to_return(body: JSON.generate(data: (1..5).map { |i| { record_type: "sim_card", id: i } }))
+      simlist = Telnyx::SimCard.list
+      assert_requested stub
+      assert_kind_of Telnyx::ListObject, simlist
+    end
+
+    should "save sim card" do
+      stub_request(:get, "#{Telnyx.api_base}/v2/sim_cards/123")
+        .to_return(body: JSON.generate(data: { record_type: "sim_card", id: "123" }))
+      stub = stub_request(:patch, "#{Telnyx.api_base}/v2/sim_cards/123")
+             .to_return(body: JSON.generate(data: { record_type: "sim_card", id: "123" }))
+      sim = Telnyx::SimCard.retrieve "123"
+      sim.save
+      assert_requested stub
+    end
+
+    context "actions" do
+      should "deactivate" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/sim_cards/123")
+          .to_return(body: JSON.generate(data: { record_type: "sim_card", id: "123" }))
+
+        stub = stub_request(:post, "#{Telnyx.api_base}/v2/sim_cards/123/actions/deactivate")
+               .to_return(body: JSON.generate(errors: []), status: 202)
+
+        sim = Telnyx::SimCard.retrieve "123"
+        sim.deactivate
+        assert_requested stub
+      end
+
+      should "activate" do
+        stub_request(:get, "#{Telnyx.api_base}/v2/sim_cards/123")
+          .to_return(body: JSON.generate(data: { record_type: "sim_card", id: "123" }))
+
+        stub = stub_request(:post, "#{Telnyx.api_base}/v2/sim_cards/123/actions/activate")
+               .to_return(body: JSON.generate(errors: []), status: 202)
+
+        sim = Telnyx::SimCard.retrieve "123"
+        sim.activate
+        assert_requested stub
+      end
+    end
+  end
+end

data/test/telnyx/telnyx_client_test.rb

@@ -324,17 +324,18 @@ module Telnyx
           assert_equal 'Invalid response object from API: "" (HTTP response code was 500)', e.message
         end
 
-        should "handle success response with empty body" do
-          stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")
-            .to_return(body: "", status: 200)
-
-          client = TelnyxClient.new
-          e = assert_raises Telnyx::APIError do
-            client.execute_request(:post, "/v2/messaging_profiles")
-          end
-
-          assert_equal 'Invalid response object from API: "" (HTTP response code was 200)', e.message
-        end
+        # Disabled this due to incompatibility with sim endpont actions.
+        # should "handle success response with empty body" do
+        #   stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")
+        #     .to_return(body: "", status: 200)
+
+        #   client = TelnyxClient.new
+        #   e = assert_raises Telnyx::APIError do
+        #     client.execute_request(:post, "/v2/messaging_profiles")
+        #   end
+
+        #   assert_equal 'Invalid response object from API: "" (HTTP response code was 200)', e.message
+        # end
 
         should "handle error response with unknown value" do
           stub_request(:post, "#{Telnyx.api_base}/v2/messaging_profiles")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: telnyx
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Telnyx
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-08 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -112,7 +112,9 @@ files:
 - lib/telnyx/messaging_profile.rb
 - lib/telnyx/number_order.rb
 - lib/telnyx/number_reservation.rb
+- lib/telnyx/phone_number.rb
 - lib/telnyx/public_key.rb
+- lib/telnyx/sim_card.rb
 - lib/telnyx/singleton_api_resource.rb
 - lib/telnyx/telnyx_client.rb
 - lib/telnyx/telnyx_object.rb
@@ -136,7 +138,9 @@ files:
 - test/telnyx/messaging_profile_test.rb
 - test/telnyx/number_order_test.rb
 - test/telnyx/number_reservation_test.rb
+- test/telnyx/phone_number_test.rb
 - test/telnyx/public_key_test.rb
+- test/telnyx/sim_card_test.rb
 - test/telnyx/telnyx_client_test.rb
 - test/telnyx/telnyx_object_test.rb
 - test/telnyx/telnyx_response_test.rb
@@ -189,7 +193,9 @@ test_files:
 - test/telnyx/messaging_profile_test.rb
 - test/telnyx/number_order_test.rb
 - test/telnyx/number_reservation_test.rb
+- test/telnyx/phone_number_test.rb
 - test/telnyx/public_key_test.rb
+- test/telnyx/sim_card_test.rb
 - test/telnyx/telnyx_client_test.rb
 - test/telnyx/telnyx_object_test.rb
 - test/telnyx/telnyx_response_test.rb