plivo 4.9.1 → 4.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90c29ef8eb386d2fd0827d9992f71f5687732ff0
-  data.tar.gz: 59b0f04856438b16248892b4f2ddbd9e79a442fe
+  metadata.gz: d641350610110aad6f806863f07423c6d00c25cc
+  data.tar.gz: 575c20c51371033efd51c06d9005bc465ea59502
 SHA512:
-  metadata.gz: fb16f471f5d7e52b7a5c982c6a7ab534a1a18aaebc9458be1e1f523d429584dc19a964a58cd66b3ef243307ddc2af79792c9fc9ab28dde526111e9658e3432e3
-  data.tar.gz: 332d920da3e1ee487a453af4b29051b16a58a6d3c33f4a54ccc58d9d46155cdac71f607412c0899ecf5f5cafb98cc6d8e251defc1a4f24110dc6741a79d865ef
+  metadata.gz: 837eec078ee00718c11d4c0ac9dd96a238d017289fb648aed9b9045373afe166f56be1eccea3d65b10d8c8276ba3a3e774682373ef4c9be6940a77dc566104db
+  data.tar.gz: 7762e64e47c88778486e5bb584aae0af7fc6ec8d1cdc1ad2025dfb9e778eb4a2d54ba0c9a57a896cf967d54ab46aac7c81b6a5364b1785708e040c894c8bc1da

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## [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
+
 ## [4.9.1](https://github.com/plivo/plivo-ruby/releases/tag/v4.9.1) (2020-08-19)
 - Internal changes in Phlo for MultiPartyCall component
 

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.9.1'
+gem 'plivo', '>= 4.14.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/calls.rb

@@ -212,7 +212,9 @@ module Plivo
           call_direction: @call_direction,
           call_duration: @call_duration,
           call_status: @call_status,
+          call_state: @call_state,
           call_uuid: @call_uuid,
+          conference_uuid: @conference_uuid,
           end_time: @end_time,
           from_number: @from_number,
           initiation_time: @initiation_time,
@@ -399,7 +401,7 @@ module Plivo
       #                                     - To filter out those numbers that contain a particular number sequence, use to_number={ sequence}
       #                                     - To filter out a number that matches an exact number, use to_number={ exact_number}
       def list_live(options = nil)
-        
+
         if options.nil?
           options = {}
         else

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

@@ -85,6 +85,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 +140,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 +269,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)
@@ -360,6 +391,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 +436,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 +482,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)

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.9.1'.freeze
+  VERSION = "4.14.0".freeze
 end

data/plivo.gemspec

@@ -31,8 +31,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'faraday', '~> 0.9'
-  spec.add_dependency 'faraday_middleware', '~> 0.12.2'
+  spec.add_dependency 'faraday', '~> 1.0.1'
+  spec.add_dependency 'faraday_middleware', '~> 1.0.0'
   spec.add_dependency 'htmlentities'
   spec.add_dependency 'jwt'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.9.1
+  version: 4.14.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -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