plivo 4.10.0 → 4.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c368bc21255a5a1cef319179fbf0bf066375b1f6
-  data.tar.gz: 929a607f7200f8060263b697680dcb610471632d
+  metadata.gz: 114dedbc98499312df91e0cdccf82b0965c633a6
+  data.tar.gz: f3e82a94f10e2bfff18d2057d67f639e114e01be
 SHA512:
-  metadata.gz: 718383feb89c897a7a3d0d91094ab09d4885b9d0054b05983b63d507678bcf152247fcfbe04ef69ecbcf8c6f3c59807240cf32a3616991c6175f35643ef0c2d8
-  data.tar.gz: 6f8b7b343a0b26f7b59259d8eea063ec1e15a41c2283316342d204a4f341cc5757e38a8f50ba78daa6515ab38972731f976a8779ab537b1e9db2ab7826f1eb48
+  metadata.gz: 22cc46f89d219c32bf3e5f59378b03d383c1737909eed8ef711f0b3e181c3e9e29ee3a1e3b75e146516ac1ac41e4241fe64aaad0c058ebce42982817ad6a151b
+  data.tar.gz: bfd4e2fc9fe8fc548239e34a9d86c319caa45f07df3002b329f1b7210cafd7342bfbc6c5dcbbde0dc01fc9c235b1f6bc053c087a12c486522ecfca9b9d19917a

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [4.15.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.15.0) (2020-11-17)
+- Add number_priority support for Powerpack API.
+
+## [4.14.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.14.0) (2020-10-30)
+- Change lookup API endpoint and response.
+
+## [4.13.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.13.0) (2020-09-30)
+- Add support for Lookup API
+
+## [4.12.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.12.0) (2020-09-24)
+- Add "public_uri" optional param support for Application API.
+
+## [4.11.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.11.0) (2020-08-25)
+- Add Powerpack for mms
+
 ## [4.10.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.10.0) (2020-09-04)
 - Add ConferenceUuid & CallState for Get Details of a Call API 
 - Upgrade faraday & faraday_middleware dependencies

data/README.md

@@ -8,7 +8,7 @@ The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby a
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'plivo', '>= 4.10.0'
+gem 'plivo', '>= 4.15.0'
 ```
 
 And then execute:
@@ -105,6 +105,18 @@ call_made = client.calls.create(
 )
 ```
 
+### Lookup a number
+
+```ruby
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+client = RestClient.new
+resp = client.lookup.get('<number-here>')
+```
+
 ### Generate Plivo XML
 
 ```ruby

data/examples/lookup.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+require "plivo"
+
+include Plivo
+include Plivo::Exceptions
+
+AUTH_ID = ""
+AUTH_TOKEN = ""
+
+client = RestClient.new(AUTH_ID, AUTH_TOKEN)
+
+# if credentials are stored in the PLIVO_AUTH_ID and the PLIVO_AUTH_TOKEN environment variables
+# then initialize client as:
+# client = RestClient.new
+
+begin
+  resp = client.lookup.get(
+    "<insert-number-here>",
+    "carrier"
+  )
+  puts resp
+rescue PlivoRESTError => e
+  puts "Exception: " + e.message
+end

data/lib/plivo/base.rb

@@ -12,5 +12,6 @@ module Plivo
 
     CALLINSIGHTS_API_URL = 'https://stats.plivo.com'.freeze
     PHLO_API_URL = 'https://phlorunner.plivo.com'.freeze
+    LOOKUP_API_URL = 'https://lookup.plivo.com'.freeze
   end
 end

data/lib/plivo/base_client.rb

@@ -61,7 +61,12 @@ module Plivo
         else
           process_response(method, response.to_hash)
         end
-
+      elsif options[:is_lookup_request] == true
+        response = case method
+                   when 'GET' then send_get(resource_path, data, timeout, is_lookup_request: options[:is_lookup_request])
+                   else raise_invalid_request("#{method} not supported by Plivo, yet")
+                   end
+        process_response(method, response.to_hash)
       else
         response = case method
                    when 'GET' then send_get(resource_path, data, timeout)
@@ -191,6 +196,18 @@ module Plivo
         faraday.adapter Faraday.default_adapter
       end
 
+      @lookup_conn = Faraday.new(@lookup_base_uri) do |faraday|
+        faraday.headers = @headers
+
+        # DANGER: Basic auth should always come after headers, else
+        # The headers will replace the basic_auth
+
+        faraday.basic_auth(auth_id, auth_token)
+
+        faraday.proxy=@proxy_hash if @proxy_hash
+        faraday.response :json, content_type: /\bjson$/
+        faraday.adapter Faraday.default_adapter
+      end
     end
 
     def send_get(resource_path, data, timeout, options = nil)
@@ -210,6 +227,11 @@ module Plivo
             req.url resource_path, data
             req.options.timeout = timeout if timeout
           end
+        elsif options[:is_lookup_request] == true
+          response = @lookup_conn.get do |req|
+            req.url resource_path, data
+            req.options.timeout = timeout if timeout
+          end
         end
       else
         response = @conn.get do |req|

data/lib/plivo/resources.rb

@@ -15,6 +15,7 @@ require_relative 'resources/nodes'
 require_relative 'resources/phlo_member'
 require_relative 'resources/call_feedback'
 require_relative 'resources/media'
+require_relative 'resources/lookup'
 
 module Plivo
   module Resources

data/lib/plivo/resources/applications.rb

@@ -24,6 +24,7 @@ module Plivo
       # @option options [Boolean] :default_endpoint_app - If set to true, this parameter ensures that newly created endpoints, which don't have an app_id, point to this application.
       # @option options [String] :subaccount - Id of the subaccount, in case only subaccount applications are needed.
       # @option options [Boolean] :log_incoming_messages - If set to true, this parameter ensures that incoming messages are logged.
+      # @option options [Boolean] :public_uri - If set to true, this parameter enables public_uri.
       # @return [Application] Application
       def update(options = nil)
         return perform_update({}) if options.nil?
@@ -48,7 +49,7 @@ module Plivo
           end
         end
 
-        %i[default_number_app default_endpoint_app log_incoming_messages].each do |param|
+        %i[default_number_app default_endpoint_app log_incoming_messages public_uri].each do |param|
           if options.key?(param) &&
              valid_param?(param, options[param], [TrueClass, FalseClass], true)
             params[param] = options[param]
@@ -134,6 +135,7 @@ module Plivo
       # @option options [Boolean] :default_endpoint_app - If set to true, this parameter ensures that newly created endpoints, which don't have an app_id, point to this application.
       # @option options [String] :subaccount - Id of the subaccount, in case only subaccount applications are needed.
       # @option options [Boolean] :log_incoming_messages - If set to true, this parameter ensures that incoming messages are logged.
+      # @option options [Boolean] :public_uri - If set to true, this parameter enables public_uri.
       # @return [Application] Application
       def create(app_name, options = nil)
         valid_param?(:app_name, app_name, [String, Symbol], true)
@@ -161,7 +163,7 @@ module Plivo
           end
         end
 
-        %i[default_number_app default_endpoint_app log_incoming_messages].each do |param|
+        %i[default_number_app default_endpoint_app log_incoming_messages public_uri].each do |param|
           if options.key?(param) &&
              valid_param?(param, options[param], [TrueClass, FalseClass], true)
             params[param] = options[param]

data/lib/plivo/resources/lookup.rb

@@ -0,0 +1,88 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+
+    class LookupBaseResource
+      def initialize(fields = nil)
+        valid_param?(:fields, fields, Hash, false)
+        fields.each do |k, v|
+          instance_variable_set("@#{k}", v)
+          self.class.send(:attr_reader, k)
+        end
+      end
+
+      def to_s
+        hash = {}
+        instance_variables.each { |var| hash[var.to_s.delete("@")] = instance_variable_get(var) }
+        hash.to_s
+      end
+    end
+
+    class Country < LookupBaseResource
+    end
+
+    class NumberFormat < LookupBaseResource
+    end
+
+    class Carrier < LookupBaseResource
+    end
+
+    # Not subclassing from Base::Resource because it cannot set nested
+    # attributes. Named the class 'LookupResponse' because the name
+    # 'Number' is already taken.
+    class LookupResponse < LookupBaseResource
+      def initialize(client, options = nil)
+        # there is no use for client here
+        valid_param?(:options, options, Hash, false)
+        parse_and_set(options[:resource_json]) if options.key?(:resource_json)
+      end
+
+      def parse_and_set(resp)
+        return unless resp
+        valid_param?(:resp, resp, Hash, true)
+
+        resp.each do |k, v|
+          case k
+          when "country"
+            instance_variable_set("@#{k}", Country.new(v))
+          when "format"
+            instance_variable_set("@#{k}", NumberFormat.new(v))
+          when "carrier"
+            instance_variable_set("@#{k}", Carrier.new(v))
+          else
+            instance_variable_set("@#{k}", v)
+          end
+          self.class.send(:attr_reader, k)
+        end
+      end
+    end
+
+    class LookupInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_resource_type = LookupResponse
+        @_identifier_string = "phone_number"
+        super
+        # Override _resource_uri only after calling super
+        @_resource_uri = "/v1/Number/"
+      end
+
+      ##
+      # Lookup a number
+      # @param [String] number
+      # @return [LookupResponse] LookupResponse
+      def get(number, type = "carrier")
+        valid_param?(:number, number, [String, Symbol], true)
+        perform_get(number, { "type" => type })
+      end
+
+      private
+
+      # overridden to ensure 'Account' and extra shash isn't added to URL path
+      def perform_get(identifier, params = nil)
+        valid_param?(:identifier, identifier, [String, Symbol], true)
+        response_json = @_client.send_request(@_resource_uri + identifier.to_s, "GET", params, nil, false, is_voice_request: @_is_voice_request, is_lookup_request: true)
+        @_resource_type.new(@_client, resource_json: response_json)
+      end
+    end
+  end
+end

data/lib/plivo/resources/powerpacks.rb

@@ -47,6 +47,9 @@ module Plivo
           if options.key?(:name) 
             params[:name] = options[:name]
           end
+          if options.key?(:number_priority) 
+            params[:number_priority] = options[:number_priority]
+          end
           perform_action_apiresponse('', 'POST', params)
         end
 
@@ -85,6 +88,10 @@ module Plivo
             valid_param?(:type, options[:type], String, true)
            params[:type] = options[:type]
           end
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
           perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number',
           'GET', params, true)
         end
@@ -136,22 +143,45 @@ module Plivo
             valid_param?(:type, options[:type], String, true)
            params[:type] = options[:type]
           end
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
           response = perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number',
           'GET', param, true)
           meta = response['meta']
           return meta['total_count']
         end
 
-        def find_number(number)
+        def find_number(number, options = nil)
           number_pool_uuid = getnumberpool_uuid(uuid)
-          perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s ,
+          if options.nil?
+            return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s ,
                        'GET')
+          end
+          params = {}
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
+          perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s ,
+                       'GET', params)
         end
 
-        def add_number(number)
+        def add_number(number, options = nil)
           number_pool_uuid = getnumberpool_uuid(uuid)
-          perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s ,
+          if options.nil?
+            return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s ,
                        'POST')
+            return
+          end
+          params = {}
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
+          perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + number.to_s ,
+                       'POST', params)
         end
 
         def add_tollfree(tollfree)
@@ -242,6 +272,10 @@ module Plivo
           number_pool_uuid = getnumberpool_uuid(uuid)
           params = {}
           params[:rent] = true
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
           if options.key?(:number)
             return perform_custom_action_apiresponse('NumberPool/' + number_pool_uuid + '/Number/' + options[:number].to_s ,
                        'POST', params)
@@ -295,7 +329,8 @@ module Plivo
             local_connect: @local_connect,
             uuid: @uuid,
             number_pool:@number_pool,
-            created_on:@created_on
+            created_on:@created_on,
+            number_priority:@number_priority
           }.to_s
         end
       end
@@ -360,6 +395,10 @@ module Plivo
             valid_param?(:type, options[:type], String, true)
            params[:type] = options[:type]
           end
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
           perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number',
           'GET', params, true)
         end
@@ -401,20 +440,42 @@ module Plivo
             valid_param?(:type, options[:type], String, true)
            params[:type] = options[:type]
           end
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
           response = perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number',
           'GET', params, true)
           meta = response['meta']
           return meta['total_count']
         end
 
-        def find(number)
-          perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
+        def find(number, options = nil)
+          if options.nil?
+            return perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
                        'GET')
+          end
+          params = {}
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
+          perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
+                       'GET', params)
         end
 
-        def add(number)
-          perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
+        def add(number, options = nil)
+          if options.nil?
+            return perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
                        'POST')
+          end
+          params = {}
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
+          perform_custom_action_apiresponse('NumberPool/' + @number_pool_id + '/Number/' + number.to_s ,
+                       'POST', params)
         end
   
         def remove(number, unrent= false)
@@ -425,6 +486,10 @@ module Plivo
         def buy_add_number(options = nil)
           params = {}
           params[:rent] = true
+          if options.key?(:service) &&
+            valid_param?(:service, options[:service], String, true)
+           params[:service] = options[:service]
+          end
           if options.key?(:number)
             return perform_custom_action_apiresponse('NumberPool/' + number_pool_id + '/Number/' + options[:number].to_s ,
                        'POST', params)
@@ -601,6 +666,12 @@ module Plivo
             valid_param?(:local_connect, options[:local_connect], [TrueClass, FalseClass], true)
            params[:local_connect] = options[:local_connect]
          end
+
+          if options.key?(:number_priority) &&
+             valid_param?(:number_priority, options[:number_priority], Array, true)
+            params[:number_priority] = options[:number_priority]
+          end
+
           perform_create(params)
         end
   

data/lib/plivo/rest_client.rb

@@ -1,6 +1,6 @@
-require_relative 'resources'
-require_relative 'base_client'
-require_relative 'base'
+require_relative "resources"
+require_relative "base_client"
+require_relative "base"
 
 module Plivo
   class RestClient < BaseClient
@@ -13,8 +13,9 @@ module Plivo
     attr_reader :call_feedback
     attr_reader :powerpacks
     attr_reader :powerpacks, :media
+    attr_reader :lookup
 
-    def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout=5)
+    def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout = 5)
       configure_base_uri
       super
       configure_interfaces
@@ -28,6 +29,7 @@ module Plivo
       @voice_base_uri_fallback_1 = Base::API_VOICE_FALLBACK_1
       @voice_base_uri_fallback_2 = Base::API_VOICE_FALLBACK_2
       @callinsights_base_uri = Base::CALLINSIGHTS_API_URL
+      @lookup_base_uri = Base::LOOKUP_API_URL
     end
 
     def configure_interfaces
@@ -47,6 +49,7 @@ module Plivo
       @addresses = Resources::AddressInterface.new(self)
       @identities = Resources::IdentityInterface.new(self)
       @call_feedback = Resources::CallFeedbackInterface.new(self)
+      @lookup = Resources::LookupInterface.new(self)
     end
   end
 end

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = '4.10.0'.freeze
+  VERSION = "4.15.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.10.0
+  version: 4.15.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -165,6 +165,7 @@ files:
 - ci/config.yml
 - examples/conference_bridge.rb
 - examples/jwt.rb
+- examples/lookup.rb
 - examples/multi_party_call.rb
 - examples/phlos.rb
 - lib/plivo.rb
@@ -185,6 +186,7 @@ files:
 - lib/plivo/resources/conferences.rb
 - lib/plivo/resources/endpoints.rb
 - lib/plivo/resources/identities.rb
+- lib/plivo/resources/lookup.rb
 - lib/plivo/resources/media.rb
 - lib/plivo/resources/messages.rb
 - lib/plivo/resources/nodes.rb