twilio-ruby 4.13.0 → 5.6.4

data/lib/twilio-ruby/framework/version.rb

@@ -0,0 +1,164 @@
+module Twilio
+  module REST
+    class Version
+      attr_accessor :domain
+
+      class RecordStream
+        include Enumerable
+
+        def initialize(page, limit: nil, page_limit: nil)
+          @page = page
+          @limit = limit
+          @page_limit = page_limit
+        end
+
+        def each
+          current_record = 0
+          current_page = 1
+
+          while @page
+            @page.each do |record|
+              yield record
+              current_record += 1
+              return nil if @limit && @limit <= current_record
+            end
+
+            return nil if @page_limit && @page_limit <= current_page
+
+            @page = @page.next_page
+            current_page += 1
+          end
+        end
+      end
+
+      def initialize(domain)
+        @domain = domain
+        @version = nil
+      end
+
+      def absolute_url(uri)
+        @domain.absolute_url(relative_uri(uri))
+      end
+
+      def relative_uri(uri)
+        "#{@version.chomp('/').gsub(/^\//, '')}/#{uri.chomp('/').gsub(/^\//, '')}"
+      end
+
+      def request(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+        url = relative_uri(uri)
+        params = params.delete_if { |_k, v| v.nil? }
+        data = data
+        @domain.request(method, url, params, data, headers, auth, timeout)
+      end
+
+      def exception(response, header)
+        message = header
+        code = response.status_code
+
+        if response.body.key?('message')
+          message += ": #{response.body['message']}"
+        end
+
+        code = response.body['code'] if response.body.key?('code')
+
+        Twilio::REST::RestError.new(message, code, response.status_code)
+      end
+
+      def fetch(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+        response = request(
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
+
+        if response.status_code < 200 || response.status_code >= 300
+          raise exception(response, 'Unable to fetch record')
+        end
+
+        response.body
+      end
+
+      def update(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
+        response = request(
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
+
+        if response.status_code < 200 || response.status_code >= 300
+          raise exception(response, 'Unable to update record')
+        end
+
+        response.body
+      end
+
+      def delete(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+        response = request(
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
+
+        if response.status_code < 200 || response.status_code >= 300
+          raise exception(response, 'Unable to delete record')
+        end
+
+        response.status_code == 204
+      end
+
+      def read_limits(limit = nil, page_size = nil)
+        page_limit = nil
+
+        unless limit.nil?
+          # If there is no user-specified page_size, pick the most network efficient size
+          page_size = limit
+          page_limit = (limit / page_size.to_f).ceil
+        end
+
+        {
+          limit: limit || nil,
+          page_size: page_size || nil,
+          page_limit: page_limit
+        }
+      end
+
+      def page(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+        request(
+          method,
+          uri,
+          params,
+          data,
+          headers,
+          auth,
+          timeout
+        )
+      end
+
+      def stream(page, limit: nil, page_limit: nil)
+        RecordStream.new(page, limit: limit, page_limit: page_limit)
+      end
+
+      def create(method, uri, params: {}, data: {}, headers: {}, auth: nil, timeout: nil)
+        response = request(method, uri, params, data, headers, auth, timeout)
+
+        if response.status_code < 200 || response.status_code >= 300
+          raise exception(response, 'Unable to create record')
+        end
+
+        response.body
+      end
+    end
+  end
+end

data/lib/twilio-ruby/http/http_client.rb

@@ -0,0 +1,58 @@
+require 'faraday'
+
+module Twilio
+  module HTTP
+    class Client
+      attr_accessor :adapter
+      attr_reader :timeout, :last_response, :last_request
+
+      def initialize(proxy_addr = nil, proxy_port = nil, proxy_user = nil, proxy_pass = nil, ssl_ca_file = nil,
+                     timeout: nil)
+        @proxy_addr = proxy_addr
+        @proxy_port = proxy_port
+        @proxy_user = proxy_user
+        @proxy_pass = proxy_pass
+        @ssl_ca_file = ssl_ca_file
+        @timeout = timeout
+        @adapter = Faraday.default_adapter
+      end
+
+      def _request(request)
+        @connection = Faraday.new(url: request.host + ':' + request.port.to_s, ssl: { verify: true }) do |f|
+          f.options.params_encoder = Faraday::FlatParamsEncoder
+          f.request :url_encoded
+          f.adapter @adapter
+          f.headers = request.headers
+          f.basic_auth(request.auth[0], request.auth[1])
+          if @proxy_addr
+            f.proxy "#{@proxy_user}:#{@proxy_pass}@#{@proxy_addr}:#{@proxy_port}"
+          end
+          f.options.open_timeout = request.timeout || @timeout
+          f.options.timeout = request.timeout || @timeout
+        end
+
+        @last_request = request
+        @last_response = nil
+        response = @connection.send(request.method.downcase.to_sym,
+                                    request.url,
+                                    request.method == 'GET' ? request.params : request.data)
+
+        if response.body && !response.body.empty?
+          object = response.body
+        elsif response.status == 400
+          object = { message: 'Bad request', code: 400 }.to_json
+        end
+
+        twilio_response = Twilio::Response.new(response.status, object, headers: response.headers)
+        @last_response = twilio_response
+
+        twilio_response
+      end
+
+      def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
+        request = Twilio::Request.new(host, port, method, url, params, data, headers, auth, timeout)
+        _request(request)
+      end
+    end
+  end
+end

data/lib/twilio-ruby/jwt/access_token.rb

@@ -0,0 +1,263 @@
+module Twilio
+  module JWT
+    module AccessTokenGrant
+      def _key
+        raise NotImplementedError
+      end
+
+      def _generate_payload
+        raise NotImplementedError
+      end
+    end
+
+    class AccessToken < BaseJWT
+      attr_accessor :account_sid,
+                    :signing_key_id,
+                    :secret,
+                    :identity,
+                    :grants,
+                    :nbf,
+                    :ttl,
+                    :valid_until
+
+      def initialize(
+        account_sid,
+        signing_key_sid,
+        secret,
+        grants = [],
+        identity: nil,
+        nbf: nil,
+        ttl: 3600,
+        valid_until: nil
+      )
+        super(secret_key: secret,
+              issuer: signing_key_sid,
+              subject: account_sid,
+              nbf: nbf,
+              ttl: ttl,
+              valid_until: valid_until)
+        @account_sid = account_sid
+        @signing_key_sid = signing_key_sid
+        @secret = secret
+        @identity = identity
+        @nbf = nbf
+        @grants = grants
+        @ttl = ttl
+        @valid_until = valid_until
+      end
+
+      def add_grant(grant)
+        @grants.push(grant)
+      end
+
+      protected
+
+      def _generate_payload
+        now = Time.now.to_i
+        grants = {}
+        grants[:identity] = @identity if @identity
+
+        @grants.each { |grant| grants[grant._key] = grant._generate_payload } unless @grants.empty?
+
+        payload = {
+          jti: "#{@signing_key_sid}-#{now}",
+          grants: grants
+        }
+
+        payload
+      end
+
+      protected
+
+      def _generate_headers
+        headers = {
+          cty: 'twilio-fpa;v=1'
+        }
+
+        headers
+      end
+
+      class ChatGrant
+        include AccessTokenGrant
+        attr_accessor :service_sid,
+                      :endpoint_id,
+                      :deployment_role_sid,
+                      :push_credential_sid
+
+        def _key
+          'chat'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          payload[:service_sid] = service_sid if service_sid
+
+          payload[:endpoint_id] = endpoint_id if endpoint_id
+
+          if deployment_role_sid
+            payload[:deployment_role_sid] = deployment_role_sid
+          end
+
+          if push_credential_sid
+            payload[:push_credential_sid] = push_credential_sid
+          end
+
+          payload
+        end
+      end
+
+      class IpMessagingGrant
+        include AccessTokenGrant
+        attr_accessor :service_sid,
+                      :endpoint_id,
+                      :deployment_role_sid,
+                      :push_credential_sid
+
+        def _key
+          'ip_messaging'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          payload[:service_sid] = service_sid if service_sid
+
+          payload[:endpoint_id] = endpoint_id if endpoint_id
+
+          if deployment_role_sid
+            payload[:deployment_role_sid] = deployment_role_sid
+          end
+
+          if push_credential_sid
+            payload[:push_credential_sid] = push_credential_sid
+          end
+
+          payload
+        end
+
+        class << self
+          extend Gem::Deprecate
+          deprecate :new, 'Chat.new', 2017, 7
+        end
+      end
+
+      class VoiceGrant
+        include AccessTokenGrant
+        attr_accessor :outgoing_application_sid,
+                      :outgoing_application_params,
+                      :push_credential_sid,
+                      :endpoint_id
+
+        def _key
+          'voice'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          if outgoing_application_sid
+            outgoing = {}
+            outgoing[:application_sid] = outgoing_application_sid
+            if outgoing_application_params
+              outgoing[:params] = outgoing_application_params
+            end
+
+            payload[:outgoing] = outgoing
+          end
+
+          if push_credential_sid
+            payload[:push_credential_sid] = push_credential_sid
+          end
+
+          payload[:endpoint_id] = endpoint_id if endpoint_id
+
+          payload
+        end
+      end
+
+      class SyncGrant
+        include AccessTokenGrant
+        attr_accessor :service_sid,
+                      :endpoint_id
+
+        def _key
+          'data_sync'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          payload['service_sid'] = service_sid if service_sid
+          payload['endpoint_id'] = endpoint_id if endpoint_id
+
+          payload
+        end
+      end
+
+      class ConversationsGrant
+        include AccessTokenGrant
+        attr_accessor :configuration_profile_sid
+
+        def _key
+          'rtc'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          if configuration_profile_sid
+            payload[:configuration_profile_sid] = configuration_profile_sid
+          end
+
+          payload
+        end
+
+        class << self
+          extend Gem::Deprecate
+          deprecate :new, 'VideoGrant.new', 2017, 5
+        end
+      end
+
+      class VideoGrant
+        include AccessTokenGrant
+        attr_accessor :room
+
+        def _key
+          'video'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          payload[:room] = room if room
+
+          payload
+        end
+      end
+
+      class TaskRouterGrant
+        include AccessTokenGrant
+        attr_accessor :workspace_sid,
+                      :worker_sid,
+                      :role
+
+        def _key
+          'task_router'
+        end
+
+        def _generate_payload
+          payload = {}
+
+          payload[:workspace_sid] = workspace_sid if workspace_sid
+
+          payload[:worker_sid] = worker_sid if worker_sid
+
+          payload[:role] = role if role
+
+          payload
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/jwt/client_capability.rb

@@ -0,0 +1,100 @@
+module Twilio
+  module JWT
+    module Scope
+      def _generate_payload
+        raise 'Not Implemented'
+      end
+    end
+
+    class ClientCapability < BaseJWT
+      attr_accessor :account_sid,
+                    :auth_token,
+                    :client_name,
+                    :scopes
+
+      def initialize(account_sid, auth_token, scopes: [], nbf: nil, ttl: 3600, valid_until: nil)
+        super(secret_key: auth_token, issuer: account_sid, nbf: nbf, ttl: ttl, valid_until: valid_until)
+        @account_sid = account_sid
+        @auth_token = auth_token
+        @client_name = nil
+        @scopes = scopes
+      end
+
+      def add_scope(scope)
+        @scopes.push(scope)
+      end
+
+      protected
+
+      def _generate_payload
+        scope = ''
+        scope = @scopes.map(&:_generate_payload).join(' ') unless @scopes.empty?
+
+        payload = {
+          scope: scope
+        }
+
+        payload
+      end
+
+      class IncomingClientScope
+        include Scope
+
+        def initialize(client_name)
+          @client_name = client_name
+        end
+
+        def _generate_payload
+          prefix = 'scope:client:incoming'
+          suffix = 'clientName=' + CGI.escape(@client_name.to_s)
+
+          [prefix, suffix].join('?')
+        end
+      end
+
+      class OutgoingClientScope
+        include Scope
+
+        def initialize(application_sid, client_name = nil, params = {})
+          @application_sid = application_sid
+          @client_name = client_name
+          @params = params
+        end
+
+        def _generate_payload
+          prefix = 'scope:client:outgoing'
+          application_sid = "appSid=#{CGI.escape(@application_sid)}"
+          unless @client_name.nil?
+            client_name = "clientName=#{CGI.escape(@client_name)}"
+          end
+          unless @params.empty?
+            params = 'appParams=' + @params.map { |k, v| CGI.escape("#{k}=#{v}") }.join('%26')
+          end
+
+          suffix = [application_sid, client_name, params].compact.join('&')
+          [prefix, suffix].join('?')
+        end
+      end
+
+      class EventStreamScope
+        include Scope
+
+        def initialize(filters = {})
+          @filters = filters
+          @path = '/2010-04-01/Events'
+        end
+
+        def _generate_payload
+          prefix = 'scope:stream:subscribe'
+          path = "path=#{CGI.escape(@path)}"
+          unless @filters.empty?
+            filters = 'params=' + @filters.map { |k, v| CGI.escape("#{k}=#{v}") }.join('&')
+          end
+
+          suffix = [path, filters].compact.join('&')
+          [prefix, suffix].join('?')
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/jwt/jwt.rb

@@ -0,0 +1,51 @@
+module Twilio
+  module JWT
+    class BaseJWT
+      # valid_until overrides ttl if specified
+      def initialize(secret_key: nil, issuer: nil, subject: nil, nbf: nil, ttl: 3600, valid_until: nil)
+        if secret_key.nil?
+          raise ArgumentError, 'JWT does not have a signing key'
+        end
+
+        @secret_key = secret_key
+        @issuer = issuer
+        @subject = subject
+        @algorithm = 'HS256'
+        @nbf = nbf
+        @ttl = ttl
+        @valid_until = valid_until
+      end
+
+      def _generate_headers
+        {}
+      end
+
+      def _generate_payload
+        raise NotImplementedError
+      end
+
+      def headers
+        headers = _generate_headers.clone
+        headers['typ'] = 'JWT'
+        headers['alg'] = @algorithm
+        headers
+      end
+
+      def payload
+        payload = _generate_payload.clone
+
+        payload[:iss] = @issuer
+        payload[:nbf] = @nbf || Time.now.to_i
+        payload[:exp] = @valid_until.nil? ? Time.now.to_i + @ttl : @valid_until
+        payload[:sub] = @subject unless @subject.nil?
+
+        payload
+      end
+
+      def to_jwt
+        ::JWT.encode payload, @secret_key, @algorithm, headers
+      end
+      alias to_s to_jwt
+    end
+  end
+end