telnyx 0.0.1

data/test/telnyx_mock.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class TelnyxMock
+    include Singleton
+
+    PATH_SPEC = "#{::File.dirname(__FILE__)}/openapi/spec3.json".freeze
+    PATH_FIXTURES = "#{::File.dirname(__FILE__)}/openapi/fixtures3.json".freeze
+
+    @pid = nil
+    @port = -1
+
+    # Starts telnyx-mock, if necessary. Returns the port on which telnyx-mock is listening.
+    def self.start
+      unless ::File.exist?(PATH_SPEC)
+        port = ENV["TELNYX_MOCK_PORT"] || 12_111
+        puts("No custom spec file found, assuming telnyx-mock is already running on port #{port}")
+        return port
+      end
+
+      unless @pid.nil?
+        puts("telnyx-mock already running on port #{@port}")
+        return @port
+      end
+
+      @port = find_available_port
+
+      puts("Starting telnyx-mock on port #{@port}...")
+
+      @stdout, @child_stdout = ::IO.pipe
+      @stderr, @child_stderr = ::IO.pipe
+
+      @pid = ::Process.spawn(
+        ["telnyx-mock", "telnyx-mock"],
+        "-http-port",
+        @port.to_s,
+        "-spec",
+        PATH_SPEC,
+        "-fixtures",
+        PATH_FIXTURES,
+        out: @child_stdout,
+        err: @child_stderr
+      )
+
+      [@child_stdout, @child_stderr].each(&:close)
+
+      sleep 1
+
+      status = (::Process.wait2(@pid, ::Process::WNOHANG) || []).last
+      if status.nil?
+        puts("Started telnyx-mock, PID = #{@pid}")
+      else
+        abort("telnyx-mock terminated early: #{status}")
+      end
+
+      @port
+    end
+
+    # Stops telnyx-mock, if necessary.
+    def self.stop
+      return if @pid.nil?
+      puts("Stopping telnyx-mock...")
+      ::Process.kill(:SIGTERM, @pid)
+      ::Process.waitpid2(@pid)
+      @pid = nil
+      @port = -1
+      puts("Stopped telnyx-mock")
+    end
+
+    # Finds and returns an available TCP port
+    private_class_method def self.find_available_port
+      server = TCPServer.new("localhost", 0)
+      port = server.addr[1]
+      server.close
+      port
+    end
+  end
+end

data/test/telnyx_test.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require ::File.expand_path("../test_helper", __FILE__)
+
+class TelnyxTest < Test::Unit::TestCase
+  should "allow app_info to be configured" do
+    begin
+      old = Telnyx.app_info
+      Telnyx.set_app_info(
+        "MyAwesomePlugin",
+        partner_id: "partner_1234",
+        url: "https://myawesomeplugin.info",
+        version: "1.2.34"
+      )
+      assert_equal({
+        name: "MyAwesomePlugin",
+        partner_id: "partner_1234",
+        url: "https://myawesomeplugin.info",
+        version: "1.2.34",
+      }, Telnyx.app_info)
+    ensure
+      Telnyx.app_info = old
+    end
+  end
+
+  should "allow max_network_retries to be configured" do
+    begin
+      old = Telnyx.max_network_retries
+      Telnyx.max_network_retries = 99
+      assert_equal 99, Telnyx.max_network_retries
+    ensure
+      Telnyx.max_network_retries = old
+    end
+  end
+
+  should "have default open and read timeouts" do
+    assert_equal Telnyx.open_timeout, 30
+    assert_equal Telnyx.read_timeout, 80
+  end
+end

data/test/test_data.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module TestData
+    def make_error(code, title, detail)
+      {
+        errors: [
+          {
+            code: code,
+            title: title,
+            detail: detail,
+          },
+        ],
+      }
+    end
+
+    def make_invalid_api_key_error
+      {
+        errors: [
+          {
+            title: "Authentication failed",
+            detail: "The required authentication headers were either invalid or not included in the request.",
+            code: "10009",
+          },
+        ],
+      }
+    end
+
+    def make_invalid_id_error
+      {
+        errors: [
+          {
+            code: "10006",
+            title: "Invalid ID",
+            detail: "The resource ID provided was invalid.",
+          },
+        ],
+      }
+    end
+
+    def make_authentication_failed_error
+      {
+        errors: [
+          {
+            title: "Authentication failed",
+            detail: "The required authentication headers were either invalid or not included in the request.",
+            code: "10009",
+          },
+        ],
+      }
+    end
+
+    def make_authorization_failed_error
+      {
+        errors: [
+          {
+            title: "Authorization failed",
+            detail: "You do not have permission to perform the requested action on the specified resource or resources.",
+            code: "10010",
+          },
+        ],
+      }
+    end
+
+    def make_resource_not_found_error
+      {
+        errors: [
+          {
+            title: "Resource not found",
+            detail: "The requested resource or URL could not be found.",
+            code: "10005",
+          },
+        ],
+      }
+    end
+
+    def make_method_not_supported_error
+      {
+        errors: [
+          {
+            title: "Method not allowed",
+            detail: "The URL is valid, but the method is not allowed.",
+            code: "10030",
+          },
+        ],
+      }
+    end
+
+    def make_rate_limit_error
+      {
+        errors: [
+          {
+            title: "Too many requests",
+            detail: "You have exceeded the maximum number of allowed requests.",
+            code: "10011",
+          },
+        ],
+      }
+    end
+
+    def make_timeout_error
+      {
+        errors: [
+          {
+            title: "Request timeout",
+            detail: "The request timed out.",
+            code: "10008",
+          },
+        ],
+      }
+    end
+
+    def make_parameters_error
+      {
+        errors: [
+          {
+            title: "Missing required parameter",
+            detail: "A required parameter was missing.",
+            code: "10004",
+          },
+        ],
+      }
+    end
+
+    def make_service_unavailable_error
+      {
+        errors: [
+          {
+            title: "Service unavailable",
+            detail: "The service is not available.",
+            code: "",
+          },
+        ],
+      }
+    end
+
+    def make_api_error
+      {
+        errors: [
+          {
+            title: "Unexpected error",
+            detail: "An unexpected error occured.",
+            code: "10007",
+          },
+        ],
+      }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "coveralls"
+Coveralls.wear!("test_frameworks")
+
+require "telnyx"
+require "test/unit"
+require "mocha/setup"
+require "stringio"
+require "shoulda/context"
+require "timecop"
+require "webmock/test_unit"
+
+PROJECT_ROOT = ::File.expand_path("../../", __FILE__)
+
+require ::File.expand_path("../test_data", __FILE__)
+require ::File.expand_path("../telnyx_mock", __FILE__)
+
+# If changing this number, please also change it in `.travis.yml`.
+MOCK_MINIMUM_VERSION = "0.40.1".freeze
+MOCK_PORT = Telnyx::TelnyxMock.start
+
+# Disable all real network connections except those that are outgoing to
+# telnyx-mock.
+WebMock.disable_net_connect!(allow: "localhost:#{MOCK_PORT}")
+
+# Try one initial test connection to telnyx-mock so that if there's a problem
+# we can print one error and fail fast so that it's more clear to the user how
+# they should fix the problem.
+begin
+  conn = Faraday::Connection.new("http://localhost:#{MOCK_PORT}")
+  resp = conn.get("/")
+  version = resp.headers["Telnyx-Mock-Version"]
+  if version != "master" &&
+     Gem::Version.new(version) < Gem::Version.new(MOCK_MINIMUM_VERSION)
+    abort("Your version of telnyx-mock (#{version}) is too old. The minimum " \
+      "version to run this test suite is #{MOCK_MINIMUM_VERSION}. Please " \
+      "see its repository for upgrade instructions.")
+  end
+rescue Faraday::ConnectionFailed
+  abort("Couldn't reach telnyx-mock at `localhost:#{MOCK_PORT}`. Is " \
+    "it running? Please see README for setup instructions.")
+end
+
+Test::Unit.at_exit do
+  Telnyx::TelnyxMock.stop
+end
+
+module Test
+  module Unit
+    class TestCase
+      include Telnyx::TestData
+      include Mocha
+
+      setup do
+        Telnyx.api_key = "KEYSUPERSECRET"
+        Telnyx.api_base = "http://localhost:#{MOCK_PORT}"
+
+        # stub_connect
+      end
+
+      teardown do
+        Telnyx.api_key = nil
+      end
+
+      private
+
+      def stub_connect
+        stub_request(:any, /^#{Telnyx.api_base}/).to_return(body: "{}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: telnyx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Telnyx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Telnyx. See https://www.telnyx.com for details.
+email: support@telnyx.com
+executables:
+- telnyx-console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".github/ISSUE_TEMPLATE.md"
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTORS
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/telnyx-console
+- lib/telnyx.rb
+- lib/telnyx/api_operations/create.rb
+- lib/telnyx/api_operations/delete.rb
+- lib/telnyx/api_operations/list.rb
+- lib/telnyx/api_operations/nested_resource.rb
+- lib/telnyx/api_operations/request.rb
+- lib/telnyx/api_operations/save.rb
+- lib/telnyx/api_resource.rb
+- lib/telnyx/available_phone_number.rb
+- lib/telnyx/errors.rb
+- lib/telnyx/event.rb
+- lib/telnyx/list_object.rb
+- lib/telnyx/message.rb
+- lib/telnyx/messaging_phone_number.rb
+- lib/telnyx/messaging_profile.rb
+- lib/telnyx/messaging_sender_id.rb
+- lib/telnyx/messaging_short_code.rb
+- lib/telnyx/number_order.rb
+- lib/telnyx/number_reservation.rb
+- lib/telnyx/public_key.rb
+- lib/telnyx/singleton_api_resource.rb
+- lib/telnyx/telnyx_client.rb
+- lib/telnyx/telnyx_object.rb
+- lib/telnyx/telnyx_response.rb
+- lib/telnyx/util.rb
+- lib/telnyx/version.rb
+- lib/telnyx/webhook.rb
+- telnyx.gemspec
+- test/api_stub_helpers.rb
+- test/openapi/README.md
+- test/telnyx/api_operations_test.rb
+- test/telnyx/api_resource_test.rb
+- test/telnyx/available_phone_number_test.rb
+- test/telnyx/errors_test.rb
+- test/telnyx/list_object_test.rb
+- test/telnyx/message_test.rb
+- test/telnyx/messaging_phone_number_test.rb
+- test/telnyx/messaging_profile_test.rb
+- test/telnyx/messaging_sender_id_test.rb
+- test/telnyx/messaging_short_code_test.rb
+- test/telnyx/number_order_test.rb
+- test/telnyx/number_reservation_test.rb
+- test/telnyx/public_key_test.rb
+- test/telnyx/telnyx_client_test.rb
+- test/telnyx/telnyx_object_test.rb
+- test/telnyx/telnyx_response_test.rb
+- test/telnyx/util_test.rb
+- test/telnyx/webhook_test.rb
+- test/telnyx_mock.rb
+- test/telnyx_test.rb
+- test/test_data.rb
+- test/test_helper.rb
+homepage: https://developers.telnyx.com/docs/api/ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the Telnyx API
+test_files:
+- test/api_stub_helpers.rb
+- test/openapi/README.md
+- test/telnyx/api_operations_test.rb
+- test/telnyx/api_resource_test.rb
+- test/telnyx/available_phone_number_test.rb
+- test/telnyx/errors_test.rb
+- test/telnyx/list_object_test.rb
+- test/telnyx/message_test.rb
+- test/telnyx/messaging_phone_number_test.rb
+- test/telnyx/messaging_profile_test.rb
+- test/telnyx/messaging_sender_id_test.rb
+- test/telnyx/messaging_short_code_test.rb
+- test/telnyx/number_order_test.rb
+- test/telnyx/number_reservation_test.rb
+- test/telnyx/public_key_test.rb
+- test/telnyx/telnyx_client_test.rb
+- test/telnyx/telnyx_object_test.rb
+- test/telnyx/telnyx_response_test.rb
+- test/telnyx/util_test.rb
+- test/telnyx/webhook_test.rb
+- test/telnyx_mock.rb
+- test/telnyx_test.rb
+- test/test_data.rb
+- test/test_helper.rb