twilio-ruby 7.3.3 → 7.10.1

data/Makefile

@@ -34,7 +34,7 @@ docker-push:
 	docker push twilio/twilio-ruby:${CURRENT_TAG}
 
 cluster-test:
-	bundle exec rspec ./cluster_spec.rb
+	bundle exec rspec ./cluster
 
 prettier:
 	bundle exec rubocop -A -d --cache true --parallel

data/README.md

@@ -39,13 +39,13 @@ This library supports the following Ruby implementations:
 To install using [Bundler][bundler] grab the latest stable version:
 
 ```ruby
-gem 'twilio-ruby', '~> 7.3.3'
+gem 'twilio-ruby', '~> 7.10.1'
 ```
 
 To manually install `twilio-ruby` via [Rubygems][rubygems] simply gem install:
 
 ```bash
-gem install twilio-ruby -v 7.3.3
+gem install twilio-ruby -v 7.10.1
 ```
 
 To build and install the development branch yourself from the latest source:
@@ -298,6 +298,11 @@ capability.add_scope(incoming_scope)
 
 There is a slightly more detailed document in the [Capability][capability] section of the wiki.
 
+## OAuth Feature for Twilio APIs
+We are introducing Client Credentials Flow-based OAuth 2.0 authentication. This feature is currently in beta and its implementation is subject to change.
+
+API examples [here](https://github.com/twilio/twilio-ruby/blob/main/examples/public_oauth.rb)
+
 ### Generate TwiML
 
 To control phone calls, your application needs to output [TwiML][twiml].

data/cluster/cluster_oauth_spec.rb

@@ -0,0 +1,19 @@
+require 'rspec/matchers'
+require 'twilio-ruby'
+require './lib/twilio-ruby/credential/client_credential_provider'
+
+describe 'Cluster Test' do
+  before(:each) do
+    @account_sid = ENV['TWILIO_ACCOUNT_SID']
+    @client_secret = ENV['TWILIO_CLIENT_SECRET']
+    @client_id = ENV['TWILIO_CLIENT_ID']
+    @message_sid = ENV['TWILIO_MESSAGE_SID']
+    @credential = Twilio::REST::ClientCredentialProvider.new(@client_id, @client_secret)
+    @client = Twilio::REST::Client.new(@account_sid).credential_provider(@credential)
+  end
+
+  it 'can fetch a message' do
+    response = @client.messages(@message_sid).fetch
+    expect(response).to_not be_nil
+  end
+end

data/cluster/cluster_orgs_spec.rb

@@ -0,0 +1,40 @@
+require 'rspec/matchers'
+require 'twilio-ruby'
+require './lib/twilio-ruby/credential/client_credential_provider'
+
+describe 'Cluster Test' do
+  before(:each) do
+    @client_secret = ENV['TWILIO_ORGS_CLIENT_SECRET']
+    @client_id = ENV['TWILIO_ORGS_CLIENT_ID']
+    @org_sid = ENV['TWILIO_ORG_SID']
+    @user_sid = ENV['TWILIO_USER_SID']
+    @account_sid = ENV['TWILIO_ORGS_ACCOUNT_SID']
+    @credential = Twilio::REST::ClientCredentialProvider.new(@client_id, @client_secret)
+    @client = Twilio::REST::Client.new.credential_provider(@credential)
+  end
+
+  it 'can list accounts' do
+    response = @client.preview_iam.organizations(@org_sid).accounts.list
+    expect(response).to_not be_nil
+  end
+
+  it 'can fetch specific account' do
+    response = @client.preview_iam.organizations(@org_sid).accounts(@account_sid).fetch
+    expect(response).to_not be_nil
+  end
+
+  it 'can access role assignments list' do
+    response = @client.preview_iam.organizations(@org_sid).role_assignments.list(scope: @account_sid)
+    expect(response).to_not be_nil
+  end
+
+  it 'can get user list' do
+    response = @client.preview_iam.organizations(@org_sid).users.list
+    expect(response).to_not be_nil
+  end
+
+  it 'can get single user' do
+    response = @client.preview_iam.organizations(@org_sid).users(@user_sid).fetch
+    expect(response).to_not be_nil
+  end
+end

data/{cluster_spec.rb → cluster/cluster_spec.rb}

@@ -1,7 +1,6 @@
 require 'rspec/matchers'
 require 'twilio-ruby'
 
-# rubocop:disable Metrics/BlockLength
 describe 'Cluster Test' do
   before(:each) do
     @account_sid = ENV['TWILIO_ACCOUNT_SID']
@@ -74,4 +73,3 @@ describe 'Cluster Test' do
     expect(@client.events.v1.sinks(sink.sid).delete).to eq(true)
   end
 end
-# rubocop:enable Metrics/BlockLength

data/examples/public_oauth.rb

@@ -0,0 +1,13 @@
+require 'twilio-ruby'
+require 'twilio-ruby/credential/client_credential_provider'
+
+credential_provider = Twilio::REST::ClientCredentialProvider.new(ENV['CLIENT_ID'], ENV['CLIENT_SECRET'])
+# passing account sid is not mandatory
+client = Twilio::REST::Client.new(ENV['ACCOUNT_SID']).credential_provider(credential_provider)
+
+# send messages
+client.messages.create(
+  from: ENV['TWILIO_PHONE_NUMBER'],
+  to: ENV['PHONE_NUMBER'],
+  body: 'Hello from Ruby!'
+)

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

@@ -0,0 +1,19 @@
+module Twilio
+  module REST
+    class AuthStrategy
+      attr_accessor :auth_type
+
+      def initialize(auth_type)
+        @auth_type = auth_type
+      end
+
+      def auth_string
+        raise NotImplementedError, 'Subclasses must implement this method'
+      end
+
+      def requires_authentication
+        raise NotImplementedError, 'Subclasses must implement this method'
+      end
+    end
+  end
+end

data/lib/twilio-ruby/auth_strategy/no_auth_strategy.rb

@@ -0,0 +1,17 @@
+module Twilio
+  module REST
+    class NoAuthStrategy < AuthStrategy
+      def initialize
+        super(AuthType::NONE)
+      end
+
+      def auth_string
+        ''
+      end
+
+      def requires_authentication
+        false
+      end
+    end
+  end
+end

data/lib/twilio-ruby/auth_strategy/token_auth_strategy.rb

@@ -0,0 +1,39 @@
+require_relative 'auth_strategy'
+require_relative './../credential/auth_type'
+require 'jwt'
+module Twilio
+  module REST
+    class TokenAuthStrategy < AuthStrategy
+      attr_accessor :token_manager, :token, :lock
+
+      def initialize(token_manager)
+        super(AuthType::ORGS_TOKEN)
+        @token = nil
+        @token_manager = token_manager
+        @lock = Mutex.new
+      end
+
+      def auth_string
+        token = fetch_token
+        "Bearer #{token}"
+      end
+
+      def fetch_token
+        @lock.synchronize do
+          @token = @token_manager.fetch_access_token if @token.nil? || token_expired? || @token == ''
+          return @token
+        end
+      end
+
+      def token_expired?
+        decoded_token = ::JWT.decode(@token, nil, false)
+        exp = decoded_token[0]['exp']
+        Time.at(exp) < Time.now
+      end
+
+      def requires_authentication
+        true
+      end
+    end
+  end
+end

data/lib/twilio-ruby/base/client_base.rb

@@ -6,7 +6,7 @@ module Twilio
       # rubocop:enable Style/ClassVars
 
       attr_accessor :http_client, :username, :password, :account_sid, :auth_token, :region, :edge, :logger,
-                    :user_agent_extensions
+                    :user_agent_extensions, :credentials
 
       # rubocop:disable Metrics/ParameterLists
       def initialize(username = nil, password = nil, account_sid = nil, region = nil, http_client = nil, logger = nil,
@@ -22,6 +22,11 @@ module Twilio
         @logger = logger || Twilio.logger
         @user_agent_extensions = user_agent_extensions || []
       end
+
+      def credential_provider(credential_provider = nil)
+        @credentials = credential_provider
+        self
+      end
       # rubocop:enable Metrics/ParameterLists
 
       ##
@@ -47,6 +52,8 @@ module Twilio
           @logger.debug("Request Params:#{params}")
         end
 
+        auth = @credentials.to_auth_strategy.auth_string unless @credentials.nil?
+
         response = @http_client.request(
           host,
           port,

data/lib/twilio-ruby/credential/auth_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class AuthType
+      BASIC = 'basic'
+      ORGS_TOKEN = 'orgs_token'
+      API_KEY = 'api_key'
+      NOAUTH = 'noauth'
+      CLIENT_CREDENTIALS = 'client_credentials'
+
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/twilio-ruby/credential/client_credential_provider.rb

@@ -0,0 +1,28 @@
+require_relative 'credential_provider'
+require_relative 'auth_type'
+require_relative './../http/client_token_manager'
+require_relative './../auth_strategy/token_auth_strategy'
+module Twilio
+  module REST
+    class ClientCredentialProvider < CredentialProvider
+      attr_accessor :grant_type, :client_id, :client_secret, :orgs_token, :auth_strategy
+
+      def initialize(client_id, client_secret, orgs_token = nil)
+        super(AuthType::ORGS_TOKEN)
+        raise ArgumentError, 'client_id and client_secret are required' if client_id.nil? || client_secret.nil?
+
+        @grant_type = 'client_credentials'
+        @client_id = client_id
+        @client_secret = client_secret
+        @orgs_token = orgs_token
+        @auth_strategy = nil
+      end
+
+      def to_auth_strategy
+        @orgs_token = ClientTokenManager.new(@grant_type, @client_id, @client_secret) if @orgs_token.nil?
+        @auth_strategy = TokenAuthStrategy.new(@orgs_token) if @auth_strategy.nil?
+        @auth_strategy
+      end
+    end
+  end
+end

data/lib/twilio-ruby/credential/credential_provider.rb

@@ -0,0 +1,11 @@
+module Twilio
+  module REST
+    class CredentialProvider
+      attr_accessor :auth_type
+
+      def initialize(auth_type)
+        @auth_type = auth_type
+      end
+    end
+  end
+end

data/lib/twilio-ruby/credential/orgs_credential_provider.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'credential_provider'
+require_relative 'auth_type'
+require_relative './../http/org_token_manager'
+require_relative './../auth_strategy/token_auth_strategy'
+module Twilio
+  module REST
+    class OrgsCredentialProvider < CredentialProvider
+      attr_accessor :grant_type, :client_id, :client_secret, :orgs_token, :auth_strategy
+
+      def initialize(client_id, client_secret, orgs_token = nil)
+        super(AuthType::ORGS_TOKEN)
+        raise ArgumentError, 'client_id and client_secret are required' if client_id.nil? || client_secret.nil?
+
+        @grant_type = 'client_credentials'
+        @client_id = client_id
+        @client_secret = client_secret
+        @orgs_token = orgs_token
+        @auth_strategy = nil
+      end
+
+      def to_auth_strategy
+        @orgs_token = OrgTokenManager.new(@grant_type, @client_id, @client_secret) if @orgs_token.nil?
+        @auth_strategy = TokenAuthStrategy.new(@orgs_token) if @auth_strategy.nil?
+        @auth_strategy
+      end
+    end
+  end
+end

data/lib/twilio-ruby/framework/rest/api_v1_version.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+require_relative 'error'
+
+module Twilio
+  module REST
+    class ApiV1Version < Version
+      attr_accessor :api_version
+
+      def initialize(domain, version)
+        super(domain)
+        @version = version.version
+        @api_version = 'v1'
+      end
+
+      def exception(response, _)
+        RestErrorV10.new(response.body)
+      end
+    end
+  end
+end

data/lib/twilio-ruby/framework/rest/domain.rb

@@ -18,7 +18,6 @@ module Twilio
 
       def request(method, uri, params = {}, data = {}, headers = {}, auth = nil, timeout = nil)
         url = uri.match(/^http/) ? uri : absolute_url(uri)
-
         @client.request(
           @base_url,
           @port,

data/lib/twilio-ruby/framework/rest/error.rb

@@ -35,5 +35,32 @@ module Twilio
 
     class ObsoleteError < StandardError
     end
+
+    class RestErrorV10 < TwilioError
+      attr_accessor :code, :message, :http_status_code, :params, :user_error
+
+      def initialize(response)
+        @code = response['code']
+        @message = response['message']
+        @http_status_code = response['httpsStatusCode']
+        @params = response['params']
+        @user_error = response['userError']
+      end
+
+      def to_s
+        message
+      end
+
+      private
+
+      def format_message(initial_message)
+        message_response = "[HTTP #{status_code}] #{code} : #{initial_message}"
+        message_response += "\n#{message}" if message
+        message_response += "\n#{http_status_code}" if http_status_code
+        message_response += "\n#{params}" if params
+        message_response += "\n#{user_error}" if user_error
+        message_response + "\n\n"
+      end
+    end
   end
 end

data/lib/twilio-ruby/framework/rest/page.rb

@@ -38,6 +38,7 @@ module Twilio
       end
 
       def load_page(payload)
+        return payload['Resources'] if payload['Resources']
         if payload['meta'] && payload['meta']['key']
           return payload[payload['meta']['key']]
         else

data/lib/twilio-ruby/framework/rest/page_metadata.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    # Page Base Class
+    class PageMetadata
+      META_KEYS = [
+        'end',
+        'first_page_uri',
+        'next_page_uri',
+        'last_page_uri',
+        'page',
+        'page_size',
+        'previous_page_uri',
+        'total',
+        'num_pages',
+        'start',
+        'uri'
+      ].freeze
+
+      def initialize(version, response)
+        payload = process_response(response)
+
+        @version = version
+        @payload = payload
+        @solution = {}
+        @records = payload
+      end
+
+      def process_response(response)
+        return response if response.status_code == 200
+
+        raise Twilio::REST::RestError.new('Unable to fetch page', response)
+      end
+
+      def get_key(payload)
+        return 'Resources' if payload['Resources']
+
+        return payload['meta']['key'] if payload['meta'] && payload['meta']['key']
+
+        keys = payload.keys
+        key = keys - META_KEYS
+        return key.first if key.size == 1
+
+        raise Twilio::REST::TwilioError, 'Page Records can not be deserialized'
+      end
+
+      def previous_page_url
+        # rubocop:disable Layout/LineLength
+        return @version.domain.absolute_url(URI.parse(@payload['meta']['previous_page_url']).request_uri) if @payload['meta'] && @payload['meta']['previous_page_url']
+        # rubocop:enable Layout/LineLength
+        return @version.domain.absolute_url(@payload['previous_page_uri']) if @payload['previous_page_uri']
+
+        nil
+      end
+
+      def next_page_url
+        # rubocop:disable Layout/LineLength
+        return @version.domain.absolute_url(URI.parse(@payload.body['meta']['next_page_url']).request_uri) if @payload.body['meta'] && @payload.body['meta']['next_page_url']
+        # rubocop:enable Layout/LineLength
+        return @version.domain.absolute_url(@payload.body['next_page_uri']) if @payload.body['next_page_uri']
+
+        nil
+      end
+
+      def previous_page
+        return nil unless previous_page_url
+
+        @version.domain.request('GET', previous_page_url)
+      end
+
+      def next_page
+        return nil unless next_page_url
+
+        @version.domain.request('GET', next_page_url)
+      end
+
+      def to_s
+        '#<PageMetadata>'
+      end
+    end
+  end
+end

data/lib/twilio-ruby/framework/rest/resource.rb

@@ -19,5 +19,21 @@ module Twilio
         @version = version
       end
     end
+
+    class InstanceResourceMetadata
+      def initialize(payload, headers, status_code)
+        @payload = payload
+        @headers = headers
+        @status_code = status_code
+      end
+    end
+
+    class InstanceListResource
+      def initialize(version, headers, status_code)
+        @version = version
+        @headers = headers
+        @status_code = status_code
+      end
+    end
   end
 end

data/lib/twilio-ruby/framework/rest/token_page.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class TokenPage < Page
+      attr_accessor :key, :page_size, :url
+
+      def initialize(version, response)
+        super(version, response)
+
+        @client = @version.domain.client.http_client
+        @url = ''
+        if @client.last_request
+          full_url = @client.last_request.url
+          uri = URI.parse(full_url)
+          @url = uri.path
+          @params = @client.last_request.params
+        end
+        @page_size = @payload['meta'] && @payload['meta']['pageSize']
+        @next_token = @payload['meta'] && @payload['meta']['nextToken']
+        @previous_token = @payload['meta'] && @payload['meta']['previousToken']
+      end
+
+      def previous_token
+        @payload['meta'] && @payload['meta']['previousToken']
+      end
+
+      def previous_page
+        cached_url = previous_page_url
+        return nil unless cached_url
+
+        response = @version.domain.request('GET', cached_url, @params)
+
+        self.class.new(@version, response, @solution)
+      end
+
+      def next_token
+        @payload['meta'] && @payload['meta']['nextToken']
+      end
+
+      def previous_page_url
+        return nil if previous_token.nil?
+
+        @params['pageToken'] = previous_token
+        @version.domain.absolute_url(@url)
+      end
+
+      def next_page_url
+        token = next_token
+        return nil if token.nil? || token.to_s.empty?
+
+        @params['pageToken'] = token
+        @version.domain.absolute_url(@url)
+      end
+
+      def next_page
+        cached_url = next_page_url
+        return nil unless cached_url
+
+        response = @version.domain.request('GET', cached_url, @params)
+
+        self.class.new(@version, response, @solution)
+      end
+
+      def load_page(payload)
+        @key ||= payload['meta'] && payload['meta']['key']
+        return @payload[@key] if @key && @payload[@key]
+
+        raise Twilio::REST::TwilioError, 'Page Records can not be deserialized'
+      end
+    end
+  end
+end