telnyx 0.0.5 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5bbc50edcbe6c58e9156791b9f5a47b3ca39b6f0232d26cbb684867370d2ce5
-  data.tar.gz: fe789738cfcf20050f518e2c7dbfa285664b4d1887fa1594d525ae5bf5922eb6
+  metadata.gz: 312011d0dba1f1fc11299f526a0d628f40814e7ed43c233f4d9fc5acd5758b5f
+  data.tar.gz: 8f3c7bd28ec643dda8ff88d9896fb510bd5fa5832837dc15b5a1692e8efcb365
 SHA512:
-  metadata.gz: c96e81e18925c27e272d0fab270b5db295394a0229077c3a26e298a68c42fade4e5d391ed817290bd591682013cd4a934ba29639566d875a316fcccce7bb25a2
-  data.tar.gz: f955905baf21c295adf7c2efb5accf4e0074104ca0c2ccfe2611b163cb9fdfc2332213dda525d66ab536c23190f0d83bcd3ec063647b5bf1fae60af968cb9dc1
+  metadata.gz: d1552a7725c8cfb0da9195f507e3a02ec491c1ab1395358938dddc777c138ca5bf0af084fb1c15c379a71a1ac115f08d8c6fd5a5c9e0938e9e0cf35a8adccdc6
+  data.tar.gz: a0dac15edc3a119ec1b049733a679bff27a91fa2740e78b31669a392ddb79185523ff42cda40e7e821dd56cff6ca519ba033bacb3251a8d3ebf434eabb68316d

data/.travis.yml

@@ -11,7 +11,7 @@ rvm:
 
 matrix:
   include:
-    - rvm: jruby-head
+    - rvm: jruby-9.2.11.0
       jdk: oraclejdk11
 
 
@@ -26,7 +26,7 @@ sudo: false
 env:
   global:
     # If changing this number, please also change it in `test/test_helper.rb`.
-    - TELNYX_MOCK_VERSION=0.4.0
+    - TELNYX_MOCK_VERSION=0.8.9
 
 cache:
   directories:

data/Gemfile

@@ -6,6 +6,7 @@ gemspec
 
 group :development do
   gem "coveralls", require: false
+  gem "faraday", "0.15.4"
   gem "mocha", "~> 0.13.2"
   gem "rake"
   gem "shoulda-context"

data/README.md

@@ -1,7 +1,8 @@
 # Telnyx Ruby Library
 
-[![Build Status](https://travis-ci.org/team-telnyx/telnyx-ruby.svg?branch=master)](https://travis-ci.org/telnyx/telnyx-ruby)
-[![Coverage Status](https://coveralls.io/repos/github/team-telnyx/telnyx-ruby/badge.svg?branch=master)](https://coveralls.io/github/telnyx/telnyx-ruby?branch=master)
+[![Build Status](https://travis-ci.org/team-telnyx/telnyx-ruby.svg?branch=master)](https://travis-ci.org/team-telnyx/telnyx-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/team-telnyx/telnyx-ruby/badge.svg?branch=master)](https://coveralls.io/github/team-telnyx/telnyx-ruby?branch=master)
+[![Join Slack](https://img.shields.io/badge/join-slack-infomational)](https://joinslack.telnyx.com/)
 
 The Telnyx Ruby library provides convenient access to the Telnyx API from
 applications written in the Ruby language. It includes a pre-defined set of
@@ -34,7 +35,7 @@ If you want to build the gem from source:
 
 ### Requirements
 
-* Ruby 2.0+.
+* Ruby 2.1.0+
 
 ### Bundler
 
@@ -65,6 +66,44 @@ Telnyx::MessagingProfile.list()
 Telnyx::MessagingProfile.retrieve("123")
 ```
 
+
+### Iterating over a resource
+
+API resources are paginated and the library comes with a handful of methods to
+ease dealing with them seemlessly.
+
+```ruby
+# list messaging profiles
+first_page = Telnyx::MessagingProfile.list()
+
+# check whether there are more pages to go through
+if first_page.more?
+  puts("There are still more pages to go.")
+else
+  puts("This is the last page.")
+end
+
+# get current page's size and number
+first_page.page_size
+first_page.page_number
+
+# fetch the next and previous pages
+second_page = first_page.next_page
+first_page = second_page.previous_page
+
+# iterate over the results of a *single page*
+second_page.each do |messaging_profile|
+  puts(messaging_profile.id)
+end
+
+# iterate over *all of the messaging profiles* starting at `first_page`
+# similar to `each`, but requests subsequent pages as needed
+first_page.auto_paging_each do |messaging_profile|
+  puts(messaging_profile.id)
+end
+```
+
+
 ### Configuring a Client
 
 While a default HTTP client is used by default, it's also possible to have the

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.1

data/bin/telnyx-console

@@ -5,7 +5,8 @@
 require "irb"
 require "irb/completion"
 
-require "#{::File.dirname(__FILE__)}/../lib/telnyx"
+$LOAD_PATH.unshift File.expand_path("lib")
+require "telnyx"
 
 # Config IRB to enable --simple-prompt and auto indent
 IRB.conf[:PROMPT_MODE] = :SIMPLE

data/lib/telnyx.rb

@@ -36,17 +36,35 @@ require "telnyx/api_resource"
 require "telnyx/singleton_api_resource"
 require "telnyx/webhook"
 
+require "telnyx/address"
 require "telnyx/alphanumeric_sender_id"
 require "telnyx/available_phone_number"
+require "telnyx/billing_group"
 require "telnyx/call"
-require "telnyx/conferences"
+require "telnyx/conference"
+require "telnyx/connection"
+require "telnyx/call_control_application"
+require "telnyx/credential_connection"
 require "telnyx/event"
+require "telnyx/fqdn_connection"
+require "telnyx/fqdn"
+require "telnyx/ip_connection"
+require "telnyx/ip"
 require "telnyx/message"
 require "telnyx/messaging_phone_number"
 require "telnyx/messaging_profile"
+require "telnyx/number_lookup"
+require "telnyx/number_order_document"
 require "telnyx/number_order"
 require "telnyx/number_reservation"
+require "telnyx/outbound_voice_profile"
+require "telnyx/phone_number_regulatory_requirement"
+require "telnyx/phone_number"
+require "telnyx/portout"
 require "telnyx/public_key"
+require "telnyx/regulatory_requirement"
+require "telnyx/sim_card"
+require "telnyx/wireless_detail_records_report"
 
 module Telnyx
   @app_info = nil

data/lib/telnyx/address.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class Address < APIResource
+    include APIOperations::Delete
+    extend APIOperations::List
+    extend APIOperations::Create
+
+    OBJECT_NAME = "address".freeze
+    RESOURCE_PATH = "addresses".freeze
+  end
+end

data/lib/telnyx/api_operations/list.rb

@@ -14,7 +14,7 @@ module Telnyx
         #
         # just for general cleanliness, remove any paging options
         obj.filters = filters.dup
-        obj.filters.delete(:page)
+        # obj.filters.delete(:page) # undo this as it interferes with the pagination system...
 
         obj
       end

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"
@@ -19,7 +20,8 @@ module Telnyx
 
         resource_url_method = :"#{resource}s_url"
         define_singleton_method(resource_url_method) do |id, nested_id = nil|
-          url = "#{resource_url}/#{CGI.escape(id)}/#{path}"
+          # raise ArgumentError, "id is required" if id.nil?
+          url = id.nil? ? "#{resource_url}/#{path}" : "#{resource_url}/#{CGI.escape(id)}/#{path}"
           url += "/#{CGI.escape(nested_id)}" unless nested_id.nil?
           url
         end
@@ -28,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/api_resource.rb

@@ -20,7 +20,7 @@ module Telnyx
       end
       # Namespaces are separated in object names with periods (.) and in URLs
       # with forward slashes (/), so replace the former with the latter.
-      "/v2/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
+      const_defined?("RESOURCE_PATH") ? "/v2/#{self::RESOURCE_PATH}" : "/v2/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
     end
 
     # A metaprogramming call that specifies that a field of a resource can be

data/lib/telnyx/billing_group.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class BillingGroup < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Delete
+    include APIOperations::Save
+
+    OBJECT_NAME = "billing_group".freeze
+  end
+end

data/lib/telnyx/call_control_application.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class CallControlApplication < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Delete
+    include APIOperations::Save
+
+    OBJECT_NAME = "call_control_application".freeze
+  end
+end

data/lib/telnyx/{conferences.rb → conference.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Telnyx
-  class Conferences < APIResource
+  class Conference < APIResource
     extend APIOperations::List
     extend APIOperations::Create
     extend APIOperations::NestedResource
@@ -16,4 +16,5 @@ module Telnyx
     end
     OBJECT_NAME = "conference".freeze
   end
+  Conferences = Conference # Name change without breaking existing code
 end

data/lib/telnyx/connection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class Connection < APIResource
+    extend Telnyx::APIOperations::List
+
+    OBJECT_NAME = "connection".freeze
+  end
+end

data/lib/telnyx/credential_connection.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class CredentialConnection < APIResource
+    extend Telnyx::APIOperations::List
+    extend Telnyx::APIOperations::Create
+    include Telnyx::APIOperations::Save
+    include Telnyx::APIOperations::Delete
+
+    OBJECT_NAME = "credential_connection".freeze
+  end
+end

data/lib/telnyx/fqdn.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class FQDN < APIResource
+    extend Telnyx::APIOperations::List
+    extend Telnyx::APIOperations::Create
+    include Telnyx::APIOperations::Delete
+    include Telnyx::APIOperations::Save
+
+    OBJECT_NAME = "fqdn".freeze
+  end
+end

data/lib/telnyx/fqdn_connection.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class FQDNConnection < APIResource
+    extend Telnyx::APIOperations::List
+    extend Telnyx::APIOperations::Create
+    include Telnyx::APIOperations::Delete
+    include Telnyx::APIOperations::Save
+
+    OBJECT_NAME = "fqdn_connection".freeze
+  end
+end

data/lib/telnyx/ip.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class IP < APIResource
+    extend Telnyx::APIOperations::List
+    extend Telnyx::APIOperations::Create
+    include Telnyx::APIOperations::Delete
+    include Telnyx::APIOperations::Save
+
+    OBJECT_NAME = "ip".freeze
+  end
+end

data/lib/telnyx/ip_connection.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Telnyx
+  class IPConnection < APIResource
+    extend APIOperations::List
+    extend APIOperations::Create
+    include APIOperations::Delete
+    include APIOperations::Save
+
+    OBJECT_NAME = "ip_connection".freeze
+  end
+end

data/lib/telnyx/list_object.rb

@@ -59,23 +59,6 @@ module Telnyx
       end
     end
 
-    # Iterates through each resource in all pages, making additional fetches to
-    # the API as necessary.
-    #
-    # Note that this method will make as many API calls as necessary to fetch
-    # all resources. For more granular control, please see +each+ and
-    # +next_page_by_token+.
-    def auto_paging_each_by_token(&blk)
-      return enum_for(:auto_paging_each_by_token) unless block_given?
-
-      page = self
-      loop do
-        page.each(&blk)
-        page = page.next_page_by_token
-        break if page.empty?
-      end
-    end
-
     # Returns true if the page object contains no elements.
     def empty?
       data.empty?
@@ -98,15 +81,7 @@ module Telnyx
     def next_page(params = {}, opts = {})
       return self.class.empty_list(opts) unless more?
       next_page_number = page_number.to_i + 1
-      pagination = { number: next_page_number, size: page_size(filters) }
-      params = filters.merge(params).merge(page: pagination)
-
-      list(params, opts)
-    end
-
-    def next_page_by_token(params = {}, opts = {})
-      return self.class.empty_list(opts) unless token
-      pagination = { token: token }
+      pagination = { number: next_page_number, size: filter_page_size }
       params = filters.merge(params).merge(page: pagination)
 
       list(params, opts)
@@ -119,37 +94,48 @@ module Telnyx
     def previous_page(params = {}, opts = {})
       prev_page_number = page_number.to_i - 1
       prev_page_number = [prev_page_number, 1].max
-      pagination = { number: prev_page_number, size: page_size(filters) }
+      pagination = { number: prev_page_number, size: filter_page_size }
       params = filters.merge(params).merge(page: pagination)
 
       list(params, opts)
     end
 
-    # Fetch the current page size
-    def page_size(params)
-      if params && params[:page] && params[:page][:size]
-        params[:page][:size]
-      else
-        20
-      end
+    # Fetch the current page size from metadata.
+    def page_size
+      from_meta(:page_size, 20)
     end
 
-    # Fetch the current page number
+    # Fetch the current page number from metadata.
     def page_number
-      if meta && meta[:page_number]
-        meta.page_number
-      else
-        1
-      end
-    end
-
-    def token
-      return meta.next_page_token if meta && meta[:next_page_token]
+      from_meta(:page_number, 1)
     end
 
     def resource_url
       url ||
         raise(ArgumentError, "List object does not contain a 'url' field.")
     end
+
+    private
+
+    # Determine page size from filters
+    def filter_page_size
+      if filters && filters[:page] && filters[:page][:size]
+        filters[:page][:size]
+      else
+        20
+      end
+    end
+
+    # Fetches `attribute` from current page metada. If it's not found returns
+    # `default`, which defaults to `nil`.
+    def from_meta(attribute, default = nil)
+      attribute = attribute.to_sym
+
+      if meta && meta[attribute]
+        meta.public_send(attribute)
+      else
+        default
+      end
+    end
   end
 end