telnyx 0.0.1

data/VERSION

@@ -0,0 +1 @@
+1.0.0b0

data/bin/telnyx-console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "irb"
+require "irb/completion"
+
+require "#{::File.dirname(__FILE__)}/../lib/telnyx"
+
+# Config IRB to enable --simple-prompt and auto indent
+IRB.conf[:PROMPT_MODE] = :SIMPLE
+IRB.conf[:AUTO_INDENT] = true
+
+puts "Loaded gem 'telnyx'"
+
+IRB.start

data/lib/telnyx.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# Telnyx Ruby bindings
+# API spec at https://developers.telnyx.com/clients
+require "cgi"
+require "faraday"
+require "json"
+require "logger"
+require "openssl"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "socket"
+require "uri"
+
+# Version
+require "telnyx/version"
+
+# API operations
+require "telnyx/api_operations/create"
+require "telnyx/api_operations/delete"
+require "telnyx/api_operations/list"
+require "telnyx/api_operations/nested_resource"
+require "telnyx/api_operations/request"
+require "telnyx/api_operations/save"
+
+# API resource support classes
+require "telnyx/errors"
+require "telnyx/util"
+require "telnyx/telnyx_client"
+require "telnyx/telnyx_object"
+require "telnyx/telnyx_response"
+require "telnyx/list_object"
+require "telnyx/api_resource"
+require "telnyx/singleton_api_resource"
+require "telnyx/webhook"
+
+require "telnyx/number_order"
+require "telnyx/number_reservation"
+require "telnyx/message"
+require "telnyx/messaging_profile"
+require "telnyx/event"
+require "telnyx/messaging_phone_number"
+require "telnyx/messaging_sender_id"
+require "telnyx/messaging_short_code"
+require "telnyx/available_phone_number"
+require "telnyx/public_key"
+
+module Telnyx
+  @app_info = nil
+
+  @api_base = ENV.fetch("TELNYX_API_BASE", "https://api.telnyx.com")
+
+  @log_level = nil
+  @logger = nil
+
+  @max_network_retries = 0
+  @max_network_retry_delay = 2
+  @initial_network_retry_delay = 0.5
+
+  @verify_ssl_certs = true
+
+  @open_timeout = 30
+  @read_timeout = 80
+
+  class << self
+    attr_accessor :telnyx_account, :api_key, :api_base, :verify_ssl_certs, :api_version, :client_id,
+                  :open_timeout, :read_timeout
+
+    attr_reader :max_network_retry_delay, :initial_network_retry_delay
+  end
+
+  # Gets the application for a plugin that's identified some. See
+  # #set_app_info.
+  def self.app_info
+    @app_info
+  end
+
+  def self.app_info=(info)
+    @app_info = info
+  end
+
+  # map to the same values as the standard library's logger
+  LEVEL_DEBUG = Logger::DEBUG
+  LEVEL_ERROR = Logger::ERROR
+  LEVEL_INFO = Logger::INFO
+
+  # When set prompts the library to log some extra information to $stdout and
+  # $stderr about what it's doing. For example, it'll produce information about
+  # requests, responses, and errors that are received. Valid log levels are
+  # `debug` and `info`, with `debug` being a little more verbose in places.
+  #
+  # Use of this configuration is only useful when `.logger` is _not_ set. When
+  # it is, the decision what levels to print is entirely deferred to the logger.
+  def self.log_level
+    @log_level
+  end
+
+  def self.log_level=(val)
+    # Backwards compatibility for values that we briefly allowed
+    if val == "debug"
+      val = LEVEL_DEBUG
+    elsif val == "info"
+      val = LEVEL_INFO
+    end
+
+    if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
+      raise ArgumentError, "log_level should only be set to `nil`, `debug` or `info`"
+    end
+    @log_level = val
+  end
+
+  # Sets a logger to which logging output will be sent. The logger should
+  # support the same interface as the `Logger` class that's part of Ruby's
+  # standard library (hint, anything in `Rails.logger` will likely be
+  # suitable).
+  #
+  # If `.logger` is set, the value of `.log_level` is ignored. The decision on
+  # what levels to print is entirely deferred to the logger.
+  def self.logger
+    @logger
+  end
+
+  def self.logger=(val)
+    @logger = val
+  end
+
+  def self.max_network_retries
+    @max_network_retries
+  end
+
+  def self.max_network_retries=(val)
+    @max_network_retries = val.to_i
+  end
+
+  # Sets some basic information about the running application that's sent along
+  # with API requests. Useful for plugin authors to identify their plugin when
+  # communicating with Telnyx.
+  #
+  # Takes a name and optional  partner program ID, plugin URL, and version.
+  def self.set_app_info(name, partner_id: nil, url: nil, version: nil)
+    @app_info = {
+      name: name,
+      partner_id: partner_id,
+      url: url,
+      version: version,
+    }
+  end
+end
+
+Telnyx.log_level = ENV["TELNYX_LOG_LEVEL"] unless ENV["TELNYX_LOG_LEVEL"].nil?

data/lib/telnyx/api_operations/create.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module APIOperations
+    module Create
+      def create(params = {}, opts = {})
+        resp, opts = request(:post, resource_url, params, opts)
+        Util.convert_to_telnyx_object(resp.data, opts)
+      end
+    end
+  end
+end

data/lib/telnyx/api_operations/delete.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module APIOperations
+    module Delete
+      def delete(params = {}, opts = {})
+        opts = Util.normalize_opts(opts)
+        resp, opts = request(:delete, resource_url, params, opts)
+        initialize_from(resp.data[:data], opts)
+      end
+    end
+  end
+end

data/lib/telnyx/api_operations/list.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module APIOperations
+    module List
+      def list(filters = {}, opts = {})
+        opts = Util.normalize_opts(opts)
+
+        resp, opts = request(:get, resource_url, filters, opts)
+        obj = ListObject.construct_from(resp.data.merge(url: resource_url), opts)
+
+        # set filters so that we can fetch the same limit, expansions, and
+        # predicates when accessing the next and previous pages
+        #
+        # just for general cleanliness, remove any paging options
+        obj.filters = filters.dup
+        obj.filters.delete(:page)
+
+        obj
+      end
+
+      # The original version of #list was given the somewhat unfortunate name of
+      # #all, and this alias allows us to maintain backward compatibility (the
+      # choice was somewhat misleading in the way that it only returned a single
+      # page rather than all objects).
+      alias all list
+    end
+  end
+end

data/lib/telnyx/api_operations/nested_resource.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module APIOperations
+    # Adds methods to help manipulate a subresource from its parent resource so
+    # 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
+    # methods `.create_reversal`, `.retrieve_reversal`, `.update_reversal`,
+    # etc. all become available.
+    module NestedResource
+      def nested_resource_class_methods(resource, path: nil, operations: nil)
+        path ||= "#{resource}s"
+        raise ArgumentError, "operations array required" if operations.nil?
+
+        resource_url_method = :"#{resource}s_url"
+        define_singleton_method(resource_url_method) do |id, nested_id = nil|
+          url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(path)}"
+          url += "/#{CGI.escape(nested_id)}" unless nested_id.nil?
+          url
+        end
+
+        operations.each do |operation|
+          case operation
+          when :create
+            define_singleton_method(:"create_#{resource}") do |id, params = {}, opts = {}|
+              url = send(resource_url_method, id)
+              resp, opts = request(:post, url, params, opts)
+              Util.convert_to_telnyx_object(resp.data, opts)
+            end
+          when :retrieve
+            define_singleton_method(:"retrieve_#{resource}") do |id, nested_id, opts = {}|
+              url = send(resource_url_method, id, nested_id)
+              resp, opts = request(:get, url, {}, opts)
+              Util.convert_to_telnyx_object(resp.data, opts)
+            end
+          when :update
+            define_singleton_method(:"update_#{resource}") do |id, nested_id, params = {}, opts = {}|
+              url = send(resource_url_method, id, nested_id)
+              resp, opts = request(:patch, url, params, opts)
+              Util.convert_to_telnyx_object(resp.data, opts)
+            end
+          when :delete
+            define_singleton_method(:"delete_#{resource}") do |id, nested_id, params = {}, opts = {}|
+              url = send(resource_url_method, id, nested_id)
+              resp, opts = request(:delete, url, params, opts)
+              Util.convert_to_telnyx_object(resp.data, opts)
+            end
+          when :list
+            define_singleton_method(:"list_#{resource}s") do |id, params = {}, opts = {}|
+              url = send(resource_url_method, id)
+              resp, opts = request(:get, url, params, opts)
+              Util.convert_to_telnyx_object(resp.data, opts)
+            end
+          else
+            raise ArgumentError, "Unknown operation: #{operation.inspect}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/api_operations/request.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module APIOperations
+    module Request
+      module ClassMethods
+        def request(method, url, params = {}, opts = {})
+          warn_on_opts_in_params(params)
+
+          opts = Util.normalize_opts(opts)
+          opts[:client] ||= TelnyxClient.active_client
+
+          headers = opts.clone
+          api_key = headers.delete(:api_key)
+          api_base = headers.delete(:api_base)
+          client = headers.delete(:client)
+          # Assume all remaining opts must be headers
+
+          resp, opts[:api_key] = client.execute_request(
+            method, url,
+            api_base: api_base, api_key: api_key,
+            headers: headers, params: params
+          )
+
+          # Hash#select returns an array before 1.9
+          opts_to_persist = {}
+          opts.each do |k, v|
+            opts_to_persist[k] = v if Util::OPTS_PERSISTABLE.include?(k)
+          end
+
+          [resp, opts_to_persist]
+        end
+
+        private
+
+        def warn_on_opts_in_params(params)
+          Util::OPTS_USER_SPECIFIED.each do |opt|
+            if params.key?(opt)
+              $stderr.puts("WARNING: #{opt} should be in opts instead of params.")
+            end
+          end
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      protected
+
+      def request(method, url, params = {}, opts = {})
+        opts = @opts.merge(Util.normalize_opts(opts))
+        self.class.request(method, url, params, opts)
+      end
+    end
+  end
+end

data/lib/telnyx/api_operations/save.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module APIOperations
+    module Save
+      module ClassMethods
+        # Updates an API resource
+        #
+        # Updates the identified resource with the passed in parameters.
+        #
+        # ==== Attributes
+        #
+        # * +id+ - ID of the resource to update.
+        # * +params+ - A hash of parameters to pass to the API
+        # * +opts+ - A Hash of additional options (separate from the params /
+        #   object values) to be added to the request. E.g. to allow for the
+        #   api_key to be overwritten. See {APIOperations::Request.request}.
+        def update(id, params = {}, opts = {})
+          params.each_key do |k|
+            if protected_fields.include?(k)
+              raise ArgumentError, "Cannot update protected field: #{k}"
+            end
+          end
+
+          resp, opts = request(:patch, "#{resource_url}/#{id}", params, opts)
+          Util.convert_to_telnyx_object(resp.data, opts)
+        end
+      end
+
+      # Creates or updates an API resource.
+      #
+      # If the resource doesn't yet have an assigned ID and the resource is one
+      # that can be created, then the method attempts to create the resource.
+      # The resource is updated otherwise.
+      #
+      # ==== Attributes
+      #
+      # * +params+ - Overrides any parameters in the resource's serialized data
+      #   and includes them in the create or update. If +:req_url:+ is included
+      #   in the list, it overrides the update URL used for the create or
+      #   update.
+      # * +opts+ - A Hash of additional options (separate from the params /
+      #   object values) to be added to the request. E.g. to allow for the
+      #   api_key to be overwritten. See {APIOperations::Request.request}.
+      def save(params = {}, opts = {})
+        # We started unintentionally (sort of) allowing attributes sent to
+        # +save+ to override values used during the update. So as not to break
+        # the API, this makes that official here.
+        update_attributes(params)
+
+        # Now remove any parameters that look like object attributes.
+        params = params.reject { |k, _| respond_to?(k) }
+
+        values = serialize_params(self).merge(params)
+
+        # note that id gets removed here our call to #url above has already
+        # generated a uri for this object with an identifier baked in
+        values.delete(:id)
+
+        resp, opts = request(save_method, save_url, values, opts)
+
+        initialize_from(resp.data[:data], opts)
+      end
+
+      def self.included(base)
+        # Set `metadata` as additive so that when it's set directly we remember
+        # to clear keys that may have been previously set by sending empty
+        # values for them.
+        #
+        # It's possible that not every object with `Save` has `metadata`, but
+        # it's a close enough heuristic, and having this option set when there
+        # is no `metadata` field is not harmful.
+        base.additive_object_param(:metadata)
+
+        base.extend(ClassMethods)
+      end
+
+      private
+
+      def save_url
+        # This switch essentially allows us "upsert"-like functionality. If the
+        # API resource doesn't have an ID set (suggesting that it's new) and
+        # its class responds to .create (which comes from
+        # Telnyx::APIOperations::Create), then use the URL to create a new
+        # resource. Otherwise, generate a URL based on the object's identifier
+        # for a normal update.
+        if self[:id].nil? && self.class.respond_to?(:create)
+          self.class.resource_url
+        else
+          resource_url
+        end
+      end
+
+      def save_method
+        if self[:id].nil? && self.class.respond_to?(:create)
+          :post
+        else
+          :patch
+        end
+      end
+    end
+  end
+end