plivo 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8d277a7f0560d74af250eccbc0074d2dbeceb36
-  data.tar.gz: daf6f39606b2e0e9d53b0a3327d6ddec90185ff1
+  metadata.gz: 8c0b51ab5d0b175827b3db20495da181efa57e07
+  data.tar.gz: be490b21e0e114d458578c5e0dc2d0b986e87959
 SHA512:
-  metadata.gz: aa164e6d25507612e12614bb132c3efdb2f720ab2e64d5d2e98199c7e693d07b6526f4e0dcd93ec029a13c8c8f50973f55dd183ad19f42594890aa8207c2403b
-  data.tar.gz: 74d62909b35e233477f90bc61ac9d55047943402be911125eabd06d9e32878c27f3321399144808ba4b18c46f1cfd55e9691fa865fef3c41d8e99b4ad5758116
+  metadata.gz: dbad3689ef259c9e549093b4b16e116e8828631e216783657a95108adde98d863f8b22cbf24ea27a76595abdd9dd49bd71fb624a6badee4fa7e77866d7149fbd
+  data.tar.gz: 6dbadf7e2797168ccf6f1778d743a2c15df300eccb9354561bf23fcbba3d14de0c814cbd2fd0e80dc5877a5d1467fe570a15b01e7d4ab290d5107ee0df4fe34e

data/CHANGELOG.md

@@ -1,9 +1,12 @@
 # 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.9.0) (2020-08-25)
+## [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)

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.12.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

@@ -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/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/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.12.0'.freeze
+  VERSION = "4.13.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-24 00:00:00.000000000 Z
+date: 2020-10-07 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