plivo 4.1.8 → 4.2.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ec37fe96e59d472a74dff83b3bd5db908445414dddbd180811b93c6a734588f
-  data.tar.gz: c22ce5d62fae7e660cde7e040f942ee0c2abf31fb821868322f78410b5929ea9
+  metadata.gz: 0e970e643746294ea9ebe794b56cf0edf400fb42af33a1226acd34c0442610fb
+  data.tar.gz: b044649e4a950a6c4ce1b85aca66484617e9603c16938d89693cef9f85def37f
 SHA512:
-  metadata.gz: 393b78238cd4752dd4fda536918c0d71da3e7bc8619de619493a7b56d9b5428e17e6709f583642e82c5b6f6bebdb3c423bf8c03bf12eac3215295b108b635cc1
-  data.tar.gz: 1ce102f968b8fe16f83972126a1eb86c89b02ce8151701ba8ccb52731c7761ca6c78e77f6b781e7805f616571587b6d741863309fc28edba192b6c737bb9d9a5
+  metadata.gz: 42f91ffb699716db5081a1fc74d76dedd0a4f8a3276bed27aeeccfe02202609554100e133f2ca2eeaa32c1db206c80fea69022dd9ccc9956e5c9c8ab04c8b9bc
+  data.tar.gz: 87a9e46d8248347f9c2ed28c1d5cbe2488634e173f911a58b5d40e392719edec3694c79c87142e7e3de23f122ac1aa39d13460e4ac5dfaf31e68a6272014ed56

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [4.2-beta1](https://github.com/plivo/plivo-ruby/releases/tag/v4.2-beta1) (2019-03-11)
+- Add PHLO support
+- Add Multi-Party Call triggers
+
 ## [4.1.8](https://github.com/plivo/plivo-ruby/releases/tag/v4.1.8) (2019-02-27)
 - Fix log_incoming_messages having no effect while application creation
 

data/examples/conference_bridge.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+client = Phlo.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 = Phlo.new
+#
+
+# provide the phlo_id in params
+begin
+  phlo = client.phlo.get('11a5f5cf-b6cd-419b-8ada-e41ef073de74')
+  conference_bridge = phlo.conference_bridge('b24d49ea-fb62-4612-9d98-4565c67f0bdc')
+  puts conference_bridge
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "name"=>"Conference_1",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }
+
+
+
+# 1. member leaves the call [HANGUP]:
+#
+# member_address => phone number of the member
+#
+# conference_bridge.member(<member_address>).hangup
+
+begin
+  response = conference_bridge.member('0000000000').hangup
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "member_address"=>"0000000000",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }
+
+
+
+# 2. Mute a member in the conference bridge:
+#
+# member_address => phone number of the member
+#
+# conference_bridge.member(<member_address>).mute
+
+begin
+  response = conference_bridge.member('0000000000').mute
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "member_address"=>"0000000000",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }
+
+
+
+# 3. Unmute a member in the conference bridge:
+#
+# member_address => phone number of the member
+#
+# conference_bridge.member(<member_address>).unmute
+
+begin
+  response = conference_bridge.member('0000000000').unmute
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id"=>"1bcee5a2-f2db-47c3-b424-49f09bc9c62a",
+#   "node_id"=>"b24d49ea-fb62-4612-9d98-4565c67f0bdc",
+#   "phlo_id"=>"11a5f5cf-b6cd-419b-8ada-e41ef073de74",
+#   "member_address"=>"0000000000",
+#   "node_type"=>"conference",
+#   "created_on"=>"2018-12-04 13:51:22.796041+00:00"
+# }

data/examples/multi_party_call.rb

@@ -0,0 +1,295 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+client = Phlo.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 = Phlo.new
+
+# provide the phlo_id in params
+phlo = client.phlo.get('phlo_id')
+
+# provide multi_party_call node id in params:
+begin
+  multi_party_call = phlo.multi_party_call('node_id')
+  puts multi_party_call
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+#------------------------------------------------------------------------
+
+# 1. Agent makes outbound call to customer:
+#
+# 'trigger_source' => Caller Id to be set when an outbound call is made to the users to be added to the multi-party call
+# 'to' => 'phone number/SIP endpoint to which an outbound call should be initiated'
+# 'role' => 'customer'/'agent'/'supervisor'
+# multi_party_call.call(<trigger_source>, <to>, <role>)
+
+begin
+  response = multi_party_call.call('9999999999', '0000000000', 'customer')
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 2. Agent initiates warm transfer:
+#
+# 'trigger_source' => number of the agent initiating warm transfer
+# 'to' => number of another agent to be added to the multi-party call
+#
+# multi_party_call.warm_transfer(<trigger_source>, <to>)
+
+begin
+  response = multi_party_call.warm_transfer('9999999999', '0000000000')
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 3. Agent initiates cold transfer:
+#
+# 'trigger_source' => number of the agent initiating cold transfer
+# 'to' => number of another agent to be added to the multi-party call
+#
+# multi_party_call.cold_transfer(<trigger_source>, <to>)
+
+begin
+  response = multi_party_call.cold_transfer('9999999999', '0000000000')
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "name": "Multi-Party Call_1",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 4. Agent abort transfer:
+#
+# agent_address => number of the agent
+#
+# multi_party_call.member(<agent_address>).abort_transfer
+
+
+begin
+  response = multi_party_call.member('0000000000').abort_transfer
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '0000000000',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 5. Agent places customer on hold:
+#
+# member_address => phone number of the member who is being put on hold
+#
+# multi_party_call.member(<member_address>).hold
+
+begin
+  response = multi_party_call.member('9999999999').hold
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 6. Resume call after hold:
+#
+# member_address => phone number of the member
+#
+# multi_party_call.member(<member_address>).unhold
+
+begin
+  response = multi_party_call.member('9999999999').unhold
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 7. Agent initiates voicemail drop:
+#
+# member_address => customer's number/endpoint
+#
+# multi_party_call.member(<member_address>).voicemail_drop
+
+begin
+  response = multi_party_call.member('9999999999').voicemail_drop
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 8. Rejoin call on warm transfer:
+#
+# agent_address => number of the agent to be added to the original conference on completion of call between agents
+#
+# multi_party_call.member(<agent_address>).resume_call
+
+begin
+  response = multi_party_call.member('0000000000').resume_call
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 9. Agent leaves of the call [HANGUP]:
+#
+# agent_address => phone number of the agent
+#
+# multi_party_call.member(<agent_address>).hangup
+
+begin
+  response = multi_party_call.member('0000000000').hangup
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 10. Customer is removed from the conference call [HANGUP]:
+#
+# customer_address => phone number of the customer
+#
+# multi_party_call.member(<customer_address>).hangup
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "node_type": "multi_party_call",
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "member_address": '9999999999',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# 11. Remove a member from the multi-party call:
+#
+# member_address => phone number of the member
+#
+# multi_party_call.member(<member_address>).remove
+
+begin
+  response = multi_party_call.member('9999999999').remove
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+# Response:
+# {
+#   "api_id": "36989807-a76f-4555-84d1-9dfdccca7a80",
+#   "id": "9999999999"
+# }

data/examples/phlos.rb

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+AUTH_ID = 'AUTH_ID'
+AUTH_TOKEN = 'AUTH_TOKEN'
+
+client = Phlo.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 = Phlo.new
+#
+
+# provide the phlo_id in params
+begin
+  phlo = client.phlo.get('phlo_id')
+  puts phlo
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Sample Response:
+# {
+#   "api_id": '36989807-a76f-4555-84d1-9dfdccca7a80',
+#   "phlo_id": 'e564a84a-7910-4447-b16f-65c541dd552c',
+#   "name": 'assignment_mpc',
+#   "created_on": '2018-11-03 19:32:33.240504+00:00'
+# }
+
+
+# initiate phlo via API request:
+begin
+  #optional parameter - params
+  params = {
+     from: '9999999999',
+     to: '0000000000'
+  }
+  response = phlo.run(params)
+  puts response
+rescue PlivoRESTError => e
+  puts 'Exception: ' + e.message
+end
+
+
+# Sample Response:
+# {
+#     :api_id=>"ff25223a-1c9f-11e4-80aa-12313f048015",
+#     :phlo_id=>"ff25223a-1c9f-11e4-80aa-12313f048015",
+#     :name=>"assignment_mpc",
+#     :created_on=>"2018-11-03 19:32:33.210714+00:00",
+#     :phlo_run_id=>"ff25223a-1c9f-11e4-80aa-12313f048015"
+# }

data/lib/plivo.rb

@@ -5,5 +5,7 @@ require_relative 'plivo/base'
 require_relative 'plivo/resources'
 require_relative 'plivo/rest_client'
 require_relative 'plivo/xml'
+require_relative 'plivo/phlo_client'
+require_relative 'plivo/base_client'
 
 module Plivo; end

data/lib/plivo/base.rb

@@ -5,5 +5,6 @@ require_relative 'base/response'
 module Plivo
   module Base
     PLIVO_API_URL = 'https://api.plivo.com'.freeze
+    PHLO_API_URL = 'https://phlorunner.plivo.com'.freeze
   end
 end

data/lib/plivo/base/resource.rb

@@ -13,7 +13,7 @@ module Plivo
       private
 
       def configure_client(client)
-        valid_param?(:client, client, RestClient, true)
+        valid_param?(:client, client, [RestClient, Phlo], true)
         @_client = client
       end
 
@@ -80,6 +80,12 @@ module Plivo
         Response.new(@_client.send_request(@_resource_uri, 'DELETE', params),
                      @_identifier_string)
       end
+
+      def perform_run(params)
+        response_json = @_client.send_request(@_resource_uri, 'POST', params, nil)
+        parse_and_set(response_json)
+        Response.new(response_json, @_identifier_string)
+      end
     end
   end
 end

data/lib/plivo/base/resource_interface.rb

@@ -11,14 +11,14 @@ module Plivo
       private
 
       def configure_client(client)
-        valid_param?(:client, client, RestClient, true)
+        valid_param?(:client, client, [RestClient, Phlo], true)
         @_client = client
       end
 
       def configure_resource_uri
         to_join = ['', 'v1', 'Account', @_client.auth_id, @_name, '']
         to_join = ['', 'v1', 'Account', ''] if @_name == 'Account'
-
+        to_join = ['', 'v1', @_name, ''] if @_name == 'phlo'
         @_resource_uri = to_join.join('/')
       end
 

data/lib/plivo/base_client.rb

@@ -0,0 +1,213 @@
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+
+require_relative 'exceptions'
+require_relative 'utils'
+require_relative 'resources'
+require_relative 'base'
+
+module Plivo
+  # Core client, used for all API requests
+  include Utils
+  class BaseClient
+    # Base stuff
+    attr_reader :headers, :auth_credentials
+
+    def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout=5)
+      configure_credentials(auth_id, auth_token)
+      configure_proxies(proxy_options)
+      configure_timeout(timeout)
+      configure_headers
+      configure_connection
+    end
+
+    def auth_id
+      @auth_credentials[:auth_id]
+    end
+
+    def process_response(method, response)
+      handle_response_exceptions(response)
+      if method == 'DELETE'
+        if response[:status] != 204
+          raise Exceptions::PlivoRESTError, "Resource at #{response[:url]} "\
+          'couldn\'t be deleted'
+        end
+      elsif !([200, 201, 202].include? response[:status])
+        raise Exceptions::PlivoRESTError, "Received #{response[:status]} for #{method}"
+      end
+
+      response[:body]
+    end
+
+    def send_request(resource_path, method = 'GET', data = {}, timeout = nil, use_multipart_conn = false)
+      timeout ||= @timeout
+
+      response = case method
+                 when 'GET' then send_get(resource_path, data, timeout)
+                 when 'POST' then send_post(resource_path, data, timeout, use_multipart_conn)
+                 when 'DELETE' then send_delete(resource_path, timeout)
+                 else raise_invalid_request("#{method} not supported by Plivo, yet")
+                 end
+
+      process_response(method, response.to_hash)
+    end
+    
+    private
+
+    def auth_token
+      @auth_credentials[:auth_token]
+    end
+
+    def configure_credentials(auth_id, auth_token)
+      # Fetches and sets the right credentials
+      auth_id ||= ENV['PLIVO_AUTH_ID']
+      auth_token ||= ENV['PLIVO_AUTH_TOKEN']
+
+      raise Exceptions::AuthenticationError, 'Couldn\'t find auth credentials' unless
+          auth_id && auth_token
+
+      raise Exceptions::AuthenticationError, "Invalid auth_id: '#{auth_id}'" unless
+          Utils.valid_account?(auth_id)
+
+      @auth_credentials = {
+          auth_id: auth_id,
+          auth_token: auth_token
+      }
+    end
+
+    def configure_proxies(proxy_dict)
+      @proxy_hash = nil
+      return unless proxy_dict
+
+      @proxy_hash = {
+          uri: "#{proxy_dict[:proxy_host]}:#{proxy_dict[:proxy_port]}",
+          user: proxy_dict[:proxy_user],
+          password: proxy_dict[:proxy_pass]
+      }
+    end
+
+    def configure_timeout(timeout)
+      @timeout = timeout
+    end
+
+    def user_agent
+      "plivo-ruby/#{Plivo::VERSION} (Ruby #{RUBY_VERSION})"
+    end
+
+    def configure_headers
+      @headers = {
+          'User-Agent' => user_agent,
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
+      }
+    end
+
+
+    def configure_connection
+      @conn = Faraday.new(@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)
+      response = @conn.get do |req|
+        req.url resource_path, data
+        req.options.timeout = timeout if timeout
+      end
+      response
+    end
+
+    def send_post(resource_path, data, timeout, use_multipart_conn)
+      if use_multipart_conn
+        multipart_conn = Faraday.new(@base_uri) do |faraday|
+          faraday.headers = {
+              'User-Agent' => @headers['User-Agent'],
+              'Accept' => @headers['Accept']
+          }
+
+          # DANGER: Basic auth should always come after headers, else
+          # The headers will replace the basic_auth
+
+          faraday.request :multipart
+          faraday.request :url_encoded
+          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
+
+        response = multipart_conn.post do |req|
+          req.url resource_path
+          req.options.timeout = timeout if timeout
+          req.body = data
+        end
+      else
+        response = @conn.post do |req|
+          req.url resource_path
+          req.options.timeout = timeout if timeout
+          req.body = JSON.generate(data) if data
+        end
+      end
+      response
+    end
+
+    def send_delete(resource_path, timeout)
+      response = @conn.delete do |req|
+        req.url resource_path
+        req.options.timeout = timeout if timeout
+      end
+      response
+    end
+
+    def handle_response_exceptions(response)
+      exception_mapping = {
+          400 => [
+              Exceptions::ValidationError,
+              'A parameter is missing or is invalid while accessing resource'
+          ],
+          401 => [
+              Exceptions::AuthenticationError,
+              'Failed to authenticate while accessing resource'
+          ],
+          404 => [
+              Exceptions::ResourceNotFoundError,
+              'Resource not found'
+          ],
+          405 => [
+              Exceptions::InvalidRequestError,
+              'HTTP method used is not allowed to access resource'
+          ],
+          500 => [
+              Exceptions::PlivoServerError,
+              'A server error occurred while accessing resource'
+          ]
+      }
+
+      response_json = response[:body]
+      return unless exception_mapping.key? response[:status]
+
+      exception_now = exception_mapping[response[:status]]
+      error_message = if (response_json.is_a? Hash) && (response_json.key? 'error')
+                        response_json['error']
+                      else
+                        exception_now[1] + " at: #{response[:url]}"
+                      end
+      if error_message.is_a?(Hash) && error_message.key?('error')
+        error_message = error_message['error']
+      end
+
+      raise exception_now[0], error_message.to_s
+    end
+  end
+end

data/lib/plivo/phlo_client.rb

@@ -0,0 +1,29 @@
+require_relative 'resources'
+require_relative 'base_client'
+require_relative 'base'
+
+module Plivo
+
+  class Phlo < BaseClient
+
+    # Resources
+    attr_reader :phlo
+
+    def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout=5)
+      configure_base_uri
+      super
+      configure_interfaces
+    end
+
+    private
+
+    def configure_base_uri
+      @base_uri = Base::PHLO_API_URL
+    end
+
+    def configure_interfaces
+      @phlo = Resources::PhloInterface.new(self)
+    end
+
+  end
+end

data/lib/plivo/resources.rb

@@ -9,6 +9,9 @@ require_relative 'resources/calls'
 require_relative 'resources/endpoints'
 require_relative 'resources/addresses'
 require_relative 'resources/identities'
+require_relative 'resources/phlos'
+require_relative 'resources/nodes'
+require_relative 'resources/member'
 
 module Plivo
   module Resources

data/lib/plivo/resources/member.rb

@@ -0,0 +1,64 @@
+module Plivo
+  module Resources
+    class Member < Base::Resource
+      def initialize(client, options)
+        @_name = 'member'
+        @_identifier_string = 'member_address'
+        super
+        configure_resource_uri
+      end
+
+      def to_s
+        {
+            api_id: @api_id,
+            node_id: @node_id,
+            phlo_id: @phlo_id,
+            node_type: @node_type,
+            member_address: @member_address,
+            created_on: @created_on
+        }.to_s
+      end
+
+      def hold
+        perform_update({action: 'hold'})
+      end
+
+      def unhold
+        perform_update({action: 'unhold'})
+      end
+
+      def voicemail_drop
+        perform_update({action: 'voicemail_drop'})
+      end
+
+      def resume_call
+        perform_update({action: 'resume_call'})
+      end
+
+      def hangup
+        perform_update({action: 'hangup'})
+      end
+
+      # def remove
+      #   perform_delete
+      # end
+
+      def mute
+        perform_update({action: 'mute'})
+      end
+
+      def unmute
+        perform_update({action: 'unmute'})
+      end
+
+      def abort_transfer
+        perform_update({action: 'abort_transfer'})
+      end
+
+      private
+      def configure_resource_uri
+        @_resource_uri = ['', 'v1', 'phlo', @phlo_id, @node_type, @node_id, 'members', @id, ''].join('/')
+      end
+    end
+  end
+end

data/lib/plivo/resources/nodes.rb

@@ -0,0 +1,83 @@
+module Plivo
+  module Resources
+    class NodeInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json=nil)
+        super
+      end
+
+      def getNode(node_id, node_type)
+        @_resource_uri = ['', 'v1', 'phlo', @_phlo_id, node_type, ''].join('/')
+        @_resource_type = configure_node_type(node_type)
+        perform_get(node_id)
+      end
+
+      private
+      def configure_node_type(node_type)
+        case node_type
+        when 'multi_party_call'
+          MultiPartyCall
+        # when 'conference_bridge'
+        #   ConferenceBridge
+        end
+      end
+    end
+
+    class Node < Base::Resource
+      def initialize(client,options=nil)
+        @_identifier_string = 'node_id'
+        super
+        configure_resource_uri
+      end
+
+      def to_s
+        {
+            api_id: @api_id,
+            node_id: @node_id,
+            phlo_id: @phlo_id,
+            name: @name,
+            node_type: @node_type,
+            created_on: @created_on
+        }.to_s
+      end
+
+      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})
+      end
+
+      private
+      def configure_resource_uri
+        @_resource_uri = ['', 'v1', 'phlo', @phlo_id, @node_type, @id, ''].join('/')
+      end
+    end
+
+    class MultiPartyCall < Node
+      def initialize(client,options=nil)
+        @_name = 'multi_party_call'
+        super
+      end
+
+      def call(trigger_source, to, role)
+        payload = {action: 'call', trigger_source: trigger_source, to: to, role: role}
+        perform_update(payload)
+      end
+
+      def warm_transfer(trigger_source, to, role='agent')
+        payload = {action: 'warm_transfer', trigger_source: trigger_source, to: to, role: role}
+        perform_update(payload)
+      end
+
+      def cold_transfer(trigger_source, to, role='agent')
+        payload = {action: 'cold_transfer', trigger_source: trigger_source, to: to, role: role}
+        perform_update(payload)
+      end
+    end
+
+    # class ConferenceBridge < Node
+    #   def initialize(client,options=nil)
+    #     @_name = 'conference_bridge'
+    #     super
+    #   end
+    # end
+  end
+end

data/lib/plivo/resources/phlos.rb

@@ -0,0 +1,55 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+
+    class Phlo < Base::Resource
+
+      def initialize(client, options = nil)
+        @_name = 'phlo'
+        @_identifier_string = 'phlo_id'
+        super
+      end
+
+      def to_s
+        {
+            api_id: @api_id,
+            phlo_id: @phlo_id,
+            name: @name,
+            created_on: @created_on,
+            phlo_run_id: @phlo_run_id
+        }.to_s
+      end
+
+      def multi_party_call(node_id)
+        nodeInterface = NodeInterface.new(@_client, {_phlo_id: @id})
+        nodeInterface.getNode(node_id, 'multi_party_call')
+      end
+
+      # def conference_bridge(node_id)
+      #   nodeInterface = NodeInterface.new(@_client, {_phlo_id: @id})
+      #   nodeInterface.getNode(node_id, 'conference_bridge')
+      # end
+
+      def run(params=nil)
+        @_resource_uri = ['', 'v1', 'account', @_client.auth_id, @_name, @id, ''].join('/')
+        perform_run(params)
+      end
+    end
+
+
+    class PhloInterface < Base::ResourceInterface
+
+      def initialize(client, resource_list_json = nil)
+        @_name = 'phlo'
+        @_resource_type = Phlo
+        super
+      end
+
+      def get(phlo_id)
+        perform_get(phlo_id)
+      end
+
+    end
+
+  end
+end

data/lib/plivo/rest_client.rb

@@ -1,18 +1,9 @@
-require 'json'
-require 'faraday'
-require 'faraday_middleware'
-
-require_relative 'exceptions'
-require_relative 'utils'
 require_relative 'resources'
+require_relative 'base_client'
 require_relative 'base'
 
 module Plivo
-  # Core client, used for all API requests
-  include Utils
-  class RestClient
-    # Base stuff
-    attr_reader :headers, :auth_credentials
+  class RestClient < BaseClient
 
     # Resources
     attr_reader :messages, :account, :subaccounts, :recordings
@@ -21,93 +12,15 @@ module Plivo
     attr_reader :addresses, :identities
 
     def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout=5)
-      configure_credentials(auth_id, auth_token)
-      configure_proxies(proxy_options)
-      configure_timeout(timeout)
-      configure_headers
-      configure_connection
+      configure_base_uri
+      super
       configure_interfaces
     end
 
-    def auth_id
-      @auth_credentials[:auth_id]
-    end
-
-    def process_response(method, response)
-      handle_response_exceptions(response)
-      if method == 'DELETE'
-        if response[:status] != 204
-          raise Exceptions::PlivoRESTError, "Resource at #{response[:url]} "\
-          'couldn\'t be deleted'
-        end
-      elsif !([200, 201, 202].include? response[:status])
-        raise Exceptions::PlivoRESTError, "Received #{response[:status]} for #{method}"
-      end
-
-      response[:body]
-    end
-
-    def send_request(resource_path, method = 'GET', data = {}, timeout = nil, use_multipart_conn = false)
-      timeout ||= @timeout
-
-      response = case method
-                 when 'GET' then send_get(resource_path, data, timeout)
-                 when 'POST' then send_post(resource_path, data, timeout, use_multipart_conn)
-                 when 'DELETE' then send_delete(resource_path, data, timeout)
-                 else raise_invalid_request("#{method} not supported by Plivo, yet")
-                 end
-
-      process_response(method, response.to_hash)
-    end
-
     private
 
-    def auth_token
-      @auth_credentials[:auth_token]
-    end
-
-    def configure_credentials(auth_id, auth_token)
-      # Fetches and sets the right credentials
-      auth_id ||= ENV['PLIVO_AUTH_ID']
-      auth_token ||= ENV['PLIVO_AUTH_TOKEN']
-
-      raise Exceptions::AuthenticationError, 'Couldn\'t find auth credentials' unless
-        auth_id && auth_token
-
-      raise Exceptions::AuthenticationError, "Invalid auth_id: '#{auth_id}'" unless
-        Utils.valid_account?(auth_id)
-
-      @auth_credentials = {
-        auth_id: auth_id,
-        auth_token: auth_token
-      }
-    end
-
-    def configure_proxies(proxy_dict)
-      @proxy_hash = nil
-      return unless proxy_dict
-
-      @proxy_hash = {
-        uri: "#{proxy_dict[:proxy_host]}:#{proxy_dict[:proxy_port]}",
-        user: proxy_dict[:proxy_user],
-        password: proxy_dict[:proxy_pass]
-      }
-    end
-
-    def configure_timeout(timeout)
-      @timeout = timeout
-    end
-
-    def user_agent
-      "plivo-ruby/#{Plivo::VERSION} (Ruby #{RUBY_VERSION})"
-    end
-
-    def configure_headers
-      @headers = {
-        'User-Agent' => user_agent,
-        'Content-Type' => 'application/json',
-        'Accept' => 'application/json'
-      }
+    def configure_base_uri
+      @base_uri = Base::PLIVO_API_URL
     end
 
     def configure_interfaces
@@ -125,112 +38,5 @@ module Plivo
       @addresses = Resources::AddressInterface.new(self)
       @identities = Resources::IdentityInterface.new(self)
     end
-
-    def configure_connection
-      @conn = Faraday.new(Base::PLIVO_API_URL) 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)
-      response = @conn.get do |req|
-        req.url resource_path, data
-        req.options.timeout = timeout if timeout
-      end
-      response
-    end
-
-    def send_post(resource_path, data, timeout, use_multipart_conn)
-      if use_multipart_conn
-        multipart_conn = Faraday.new(Base::PLIVO_API_URL) do |faraday|
-          faraday.headers = {
-            'User-Agent' => @headers['User-Agent'],
-            'Accept' => @headers['Accept']
-          }
-
-          # DANGER: Basic auth should always come after headers, else
-          # The headers will replace the basic_auth
-
-          faraday.request :multipart
-          faraday.request :url_encoded
-          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
-
-        response = multipart_conn.post do |req|
-          req.url resource_path
-          req.options.timeout = timeout if timeout
-          req.body = data
-        end
-      else
-        response = @conn.post do |req|
-          req.url resource_path
-          req.options.timeout = timeout if timeout
-          req.body = JSON.generate(data) if data
-        end
-      end
-      response
-    end
-
-    def send_delete(resource_path, data, timeout)
-      response = @conn.delete do |req|
-        req.url resource_path
-        req.options.timeout = timeout if timeout
-        req.body = JSON.generate(data) if data
-      end
-      response
-    end
-
-    def handle_response_exceptions(response)
-      exception_mapping = {
-        400 => [
-          Exceptions::ValidationError,
-          'A parameter is missing or is invalid while accessing resource'
-        ],
-        401 => [
-          Exceptions::AuthenticationError,
-          'Failed to authenticate while accessing resource'
-        ],
-        404 => [
-          Exceptions::ResourceNotFoundError,
-          'Resource not found'
-        ],
-        405 => [
-          Exceptions::InvalidRequestError,
-          'HTTP method used is not allowed to access resource'
-        ],
-        500 => [
-          Exceptions::PlivoServerError,
-          'A server error occurred while accessing resource'
-        ]
-      }
-
-      response_json = response[:body]
-      return unless exception_mapping.key? response[:status]
-
-      exception_now = exception_mapping[response[:status]]
-      error_message = if (response_json.is_a? Hash) && (response_json.key? 'error')
-                        response_json['error']
-                      else
-                        exception_now[1] + " at: #{response[:url]}"
-                      end
-      if error_message.is_a?(Hash) && error_message.key?('error')
-        error_message = error_message['error']
-      end
-
-      raise exception_now[0], error_message.to_s
-    end
   end
 end

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = '4.1.8'.freeze
+  VERSION = '4.2.0-beta1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.1.8
+  version: 4.2.0.pre.beta1
 platform: ruby
 authors:
 - The Plivo SDKs Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-27 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -147,12 +147,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/conference_bridge.rb
+- examples/multi_party_call.rb
+- examples/phlos.rb
 - lib/plivo.rb
 - lib/plivo/base.rb
 - lib/plivo/base/resource.rb
 - lib/plivo/base/resource_interface.rb
 - lib/plivo/base/response.rb
+- lib/plivo/base_client.rb
 - lib/plivo/exceptions.rb
+- lib/plivo/phlo_client.rb
 - lib/plivo/resources.rb
 - lib/plivo/resources/accounts.rb
 - lib/plivo/resources/addresses.rb
@@ -161,8 +166,11 @@ files:
 - lib/plivo/resources/conferences.rb
 - lib/plivo/resources/endpoints.rb
 - lib/plivo/resources/identities.rb
+- lib/plivo/resources/member.rb
 - lib/plivo/resources/messages.rb
+- lib/plivo/resources/nodes.rb
 - lib/plivo/resources/numbers.rb
+- lib/plivo/resources/phlos.rb
 - lib/plivo/resources/pricings.rb
 - lib/plivo/resources/recordings.rb
 - lib/plivo/rest_client.rb
@@ -202,9 +210,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.8