plivo 4.9.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb94696da06990a70578e5b44e4eb14df13ff9ab
-  data.tar.gz: c8d2d47ddd432b5f15adc75a8fc09d3c0c8f7a82
+  metadata.gz: 8c0b51ab5d0b175827b3db20495da181efa57e07
+  data.tar.gz: be490b21e0e114d458578c5e0dc2d0b986e87959
 SHA512:
-  metadata.gz: 1a08ee7057cae689aedd2608b23a2fc5184a94ac13786b9a43a47d588e8d987c86ad2a4a86487826a0f8056e0fcd44a2e362d38fb806c95b9ba4ac11751a068c
-  data.tar.gz: 1b8e9f01eaf93503fca9924c045455c7c18500d2a3e081259b3d6175e36ab33ae2f14d7b12ba4445d3c0c4920a457ef798ae6672fa1a1918047b21a0250acc88
+  metadata.gz: dbad3689ef259c9e549093b4b16e116e8828631e216783657a95108adde98d863f8b22cbf24ea27a76595abdd9dd49bd71fb624a6badee4fa7e77866d7149fbd
+  data.tar.gz: 6dbadf7e2797168ccf6f1778d743a2c15df300eccb9354561bf23fcbba3d14de0c814cbd2fd0e80dc5877a5d1467fe570a15b01e7d4ab290d5107ee0df4fe34e

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change Log
 
+## [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
+
 ## [4.9.0](https://github.com/plivo/plivo-ruby/releases/tag/v4.9.0) (2020-07-23)
 - Add retries to multiple regions for voice requests.
 

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.0'
+gem 'plivo', '>= 4.13.0'
 ```
 
 And then execute:
@@ -105,6 +105,21 @@ call_made = client.calls.create(
 )
 ```
 
+### Lookup a number
+
+```ruby
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+client = RestClient.new
+resp = client.lookup.get(
+  '<number-here>',
+  "carrier"
+)
+```
+
 ### 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/resources.rb

@@ -12,9 +12,10 @@ require_relative 'resources/addresses'
 require_relative 'resources/identities'
 require_relative 'resources/phlos'
 require_relative 'resources/nodes'
-require_relative 'resources/member'
+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/Lookup/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)
+        @_resource_type.new(@_client, resource_json: response_json)
+      end
+    end
+  end
+end

data/lib/plivo/resources/nodes.rb

@@ -15,7 +15,7 @@ module Plivo
       def configure_node_type(node_type)
         case node_type
         when 'multi_party_call'
-          MultiPartyCall
+          PhloMultiPartyCall
         # when 'conference_bridge'
         #   ConferenceBridge
         end
@@ -42,7 +42,7 @@ module Plivo
 
       def member(member_address)
         options = {'member_address' => member_address, 'node_id' => @id, 'phlo_id' => @phlo_id, 'node_type' => @node_type}
-        Member.new(@_client, {resource_json: options})
+        PhloMember.new(@_client, {resource_json: options})
       end
 
       private
@@ -51,7 +51,7 @@ module Plivo
       end
     end
 
-    class MultiPartyCall < Node
+    class PhloMultiPartyCall < Node
       def initialize(client,options=nil)
         @_name = 'multi_party_call'
         super

data/lib/plivo/resources/{member.rb → phlo_member.rb}

@@ -1,6 +1,6 @@
 module Plivo
   module Resources
-    class Member < Base::Resource
+    class PhloMember < Base::Resource
       def initialize(client, options)
         @_name = 'member'
         @_identifier_string = 'member_address'

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
@@ -47,6 +48,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.0'.freeze
+  VERSION = "4.13.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.0
+  version: 4.13.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-10-07 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,11 +186,12 @@ 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/member.rb
 - lib/plivo/resources/messages.rb
 - lib/plivo/resources/nodes.rb
 - lib/plivo/resources/numbers.rb
+- lib/plivo/resources/phlo_member.rb
 - lib/plivo/resources/phlos.rb
 - lib/plivo/resources/powerpacks.rb
 - lib/plivo/resources/pricings.rb