plivo 0.3.19 → 4.0.0.beta.2

data/lib/plivo/resources/pricings.rb

@@ -0,0 +1,43 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+    class Pricing < Base::Resource
+      def initialize(client, options = nil)
+        @_name = 'Pricing'
+        @_identifier_string = 'country_iso'
+        super
+      end
+
+      def to_s
+        {
+          api_id: @api_id,
+          country: @country,
+          country_code: @country_code,
+          country_iso: @country_iso,
+          message: @message,
+          phone_numbers: @phone_numbers,
+          voice: @voice
+        }.to_s
+      end
+    end
+
+    class PricingInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = 'Pricing'
+        @_resource_type = Pricing
+        @_identifier_string = 'country_iso'
+        super
+      end
+
+      # @param [String] country_iso
+      def get(country_iso)
+        valid_param?(:country_iso, country_iso, [String, Symbol], true)
+        unless country_iso.length == 2
+          raise_invalid_request('country_iso should be of length 2')
+        end
+        params = { country_iso: country_iso }
+        perform_get_without_identifier(params)
+      end
+    end
+  end
+end

data/lib/plivo/resources/recordings.rb

@@ -0,0 +1,114 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+    class Recording < Base::Resource
+      def initialize(client, options = nil)
+        @_name = 'Recording'
+        @_identifier_string = 'recording_id'
+        super
+      end
+
+      def delete
+        perform_delete
+      end
+
+      def to_s
+        {
+          add_time: @add_time,
+          api_id: @api_id,
+          call_uuid: @call_uuid,
+          conference_name: @conference_name,
+          recording_duration_ms: @recording_duration_ms,
+          recording_end_ms: @recording_end_ms,
+          recording_format: @recording_format,
+          recording_id: @recording_id,
+          recording_start_ms: @recording_start_ms,
+          recording_type: @recording_type,
+          recording_url: @recording_url,
+          resource_uri: @resource_uri
+        }.to_s
+      end
+    end
+
+    class RecordingInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = 'Recording'
+        @_resource_type = Recording
+        @_identifier_string = 'recording_id'
+        super
+      end
+
+      # @param [Hash] options
+      # @option options [String] :subaccount auth_id of the subaccount. Lists only those recordings of the main accounts which are tied to the specified subaccount.
+      # @option options [String] :call_uuid Used to filter recordings for a specific call.
+      # @option options [String] :add_time Used to filter out recordings according to the time they were added.The add_time filter is a comparative filter that can be used in the following four forms:
+      #                                    - add_time\__gt: gt stands for greater than. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started after 2012-03-21 11:47, use add_time\__gt=2012-03-21 11:47
+      #                                    - add_time\__gte: gte stands for greater than or equal. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started after or exactly at 2012-03-21 11:47[:30], use add_time\__gte=2012-03-21 11:47[:30]
+      #                                    - add_time\__lt: lt stands for lesser than. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started before 2012-03-21 11:47, use add_time\__lt=2012-03-21 11:47
+      #                                    - add_time\__gte: lte stands for lesser than or equal. The format expected is YYYY-MM-DD HH:MM[:ss[.uuuuuu]]. Eg:- To get all recordings that started before or exactly at 2012-03-21 11:47[:30], use add_time\__lte=2012-03-21 11:47[:30]
+      #                                    - Note: The above filters can be combined to get recordings that started in a particular time range.
+      # @option options [Int] :limit Used to display the number of results per page. The maximum number of results that can be fetched is 20.
+      # @option options [Int] :offset Denotes the number of value items by which the results should be offset. Eg:- If the result contains a 1000 values and limit is set to 10 and offset is set to 705, then values 706 through 715 are displayed in the results. This parameter is also used for pagination of the results.
+      def list(options = nil)
+        return perform_list if options.nil?
+        valid_param?(:options, options, Hash, true)
+
+        params = {}
+        params_expected = %i[
+          call_uuid add_time__gt add_time__gte
+          add_time__lt add_time__lte
+        ]
+
+        params_expected.each do |param|
+          if options.key?(param) && valid_param?(param, options[param], [String, Symbol], true)
+            params[param] = options[param]
+          end
+        end
+
+        if options.key?(:subaccount) &&
+           valid_subaccount?(options[:subaccount], true)
+          params[:subaccount] = options[:subaccount]
+        end
+
+        %i[offset limit].each do |param|
+          if options.key?(param) && valid_param?(param, options[param], [Integer, Integer], true)
+            params[param] = options[param]
+          end
+        end
+
+        if options.key?(:limit) && (options[:limit] > 20 || options[:limit] <= 0)
+          raise_invalid_request('The maximum number of results that can be fetched'\
+          " is 20. limit can't be more than 20 or less than 1")
+        end
+
+        raise_invalid_request("Offset can't be negative") if options.key?(:offset) && options[:offset] < 0
+
+        perform_list(params)
+      end
+
+      # @param [String] recording_id
+      def get(recording_id)
+        valid_param?(:recording_id, recording_id, [String, Symbol], true)
+        raise_invalid_request('Invalid recording_id passed') if recording_id.empty?
+        perform_get(recording_id)
+      end
+
+      def each
+        offset = 0
+        loop do
+          recording_list = list(offset: offset)
+          recording_list[:objects].each { |recording| yield recording }
+          offset += 20
+          return unless recording_list.length == 20
+        end
+      end
+
+      # @param [String] recording_id
+      def delete(recording_id)
+        valid_param?(:recording_id, recording_id, [String, Symbol], true)
+        raise_invalid_request('Invalid recording_id passed') if recording_id.empty?
+        Recording.new(@_client, resource_id: recording_id).delete
+      end
+    end
+  end
+end

data/lib/plivo/rest_client.rb

@@ -0,0 +1,199 @@
+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 RestClient
+    # Base stuff
+    attr_reader :headers, :auth_credentials
+
+    # Resources
+    attr_reader :messages, :account, :subaccounts, :recordings
+    attr_reader :pricings, :numbers, :calls, :conferences
+    attr_reader :phone_numbers, :applications, :endpoints
+
+    def initialize(auth_id = nil, auth_token = nil, proxy_options = nil)
+      configure_credentials(auth_id, auth_token)
+      configure_proxies(proxy_options)
+      configure_headers
+      configure_connection
+      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)
+      response = case method
+                 when 'GET' then send_get(resource_path, data, timeout)
+                 when 'POST' then send_post(resource_path, data, timeout)
+                 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 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_interfaces
+      @account = Resources::AccountInterface.new(self)
+      @messages = Resources::MessagesInterface.new(self)
+      @subaccounts = Resources::SubaccountInterface.new(self)
+      @recordings = Resources::RecordingInterface.new(self)
+      @pricings = Resources::PricingInterface.new(self)
+      @numbers = Resources::NumberInterface.new(self)
+      @phone_numbers = Resources::PhoneNumberInterface.new(self)
+      @conferences = Resources::ConferenceInterface.new(self)
+      @calls = Resources::CallInterface.new(self)
+      @endpoints = Resources::EndpointInterface.new(self)
+      @applications = Resources::ApplicationInterface.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)
+      response = @conn.post do |req|
+        req.url resource_path
+        req.options.timeout = timeout if timeout
+        req.body = JSON.generate(data) if data
+      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/utils.rb

@@ -0,0 +1,107 @@
+require 'openssl'
+require 'uri'
+
+module Plivo
+  # Utils module
+  module Utils
+    module_function
+
+    def valid_account?(account_id, raise_directly = false)
+      valid_subaccount?(account_id, raise_directly) || valid_mainaccount?(account_id, raise_directly)
+    end
+
+    # @param [String] account_id
+    # @param [Boolean] raise_directly
+    def valid_subaccount?(account_id, raise_directly = false)
+      unless account_id.is_a? String
+        return false unless raise_directly
+        raise_invalid_request('subaccount_id must be a string')
+      end
+
+      if account_id.length != 20
+        return false unless raise_directly
+        raise_invalid_request('subaccount_id should be of length 20')
+      end
+
+      if account_id[0..1] != 'SA'
+        return false unless raise_directly
+        raise_invalid_request("subaccount_id should start with 'SA'")
+      end
+      true
+    end
+
+    def valid_mainaccount?(account_id, raise_directly = false)
+      unless account_id.is_a? String
+        return false unless raise_directly
+        raise_invalid_request('account_id must be a string')
+      end
+
+      if account_id.length != 20
+        return false unless raise_directly
+        raise_invalid_request('account_id should be of length 20')
+      end
+
+      if account_id[0..1] != 'MA'
+        return false unless raise_directly
+        raise_invalid_request("account_id should start with 'SA'")
+      end
+      true
+    end
+
+    def raise_invalid_request(message = '')
+      raise Exceptions::InvalidRequestError, message
+    end
+
+    def valid_param?(param_name, param_value, expected_types = nil, mandatory = false, expected_values = nil)
+      if mandatory && param_value.nil?
+        raise_invalid_request("#{param_name} is a required parameter")
+      end
+
+      return true if param_value.nil?
+
+      return expected_type?(param_name, expected_types, param_value) unless expected_values
+      expected_value?(param_name, expected_values, param_value)
+    end
+
+    def expected_type?(param_name, expected_types, param_value)
+      return true if expected_types.nil?
+      param_value_class = param_value.class
+      param_value_class = Integer if [Fixnum, Bignum].include? param_value_class
+      if expected_types.is_a? Array
+        return true if expected_types.include? param_value_class
+        raise_invalid_request("#{param_name}: Expected one of #{expected_types}"\
+          " but received #{param_value.class} instead")
+      else
+        return true if expected_types == param_value_class
+        raise_invalid_request("#{param_name}: Expected a #{expected_types}"\
+          " but received #{param_value.class} instead")
+      end
+    end
+
+    def expected_value?(param_name, expected_values, param_value)
+      return true if expected_values.nil?
+      if expected_values.is_a? Array
+        return true if expected_values.include? param_value
+        raise_invalid_request("#{param_name}: Expected one of #{expected_values}"\
+          " but received '#{param_value}' instead")
+      else
+        return true if expected_values == param_value
+        raise_invalid_request("#{param_name}: Expected '#{expected_values}'"\
+          " but received '#{param_value}' instead")
+      end
+    end
+
+    # @param [String] uri
+    # @param [String] nonce
+    # @param [String] signature
+    # @param [String] auth_token
+    def valid_signature?(uri, nonce, signature, auth_token)
+      parsed_uri = URI.parse(uri)
+      uri_details = { host: parsed_uri.host, path: parsed_uri.path }
+      uri_builder_module = parsed_uri.scheme == 'https' ? URI::HTTPS : URI::HTTP
+      data_to_sign = uri_builder_module.build(uri_details).to_s + nonce
+      sha256_digest = OpenSSL::Digest.new('sha256')
+      Base64.encode64(OpenSSL::HMAC.digest(sha256_digest, auth_token, data_to_sign)).strip() == signature
+    end
+  end
+end