twilio-ruby 5.0.0.rc10 → 5.0.0.rc11

data/lib/twilio-ruby/task_router/capability.rb

@@ -1,87 +0,0 @@
-module Twilio
-  module TaskRouter
-    class Capability
-
-      TASK_ROUTER_BASE_URL = 'https://taskrouter.twilio.com'
-      TASK_ROUTER_VERSION = 'v1'
-      TASK_ROUTER_WEBSOCKET_BASE_URL = 'https://event-bridge.twilio.com/v1/wschannels'
-
-      REQUIRED = {required: true}
-      OPTIONAL = {required: false}
-
-      def initialize(account_sid, auth_token, workspace_sid, worker_sid)
-        @account_sid = account_sid
-        @auth_token = auth_token
-        @workspace_sid = workspace_sid
-        @worker_sid = worker_sid
-        @policies = []
-        allow_websocket_requests
-        allow_activity_list_fetch
-      end
-
-      def workspace_url
-        "#{TASK_ROUTER_BASE_URL}/#{TASK_ROUTER_VERSION}/Workspaces/#{@workspace_sid}"
-      end
-
-      def worker_url
-        "#{workspace_url}/Workers/#{@worker_sid}"
-      end
-
-      def allow_worker_activity_updates
-        add_policy(worker_url, "POST", nil, {ActivitySid: REQUIRED})
-      end
-
-      def allow_worker_fetch_attributes
-        add_policy(worker_url, "GET")
-      end
-
-      def allow_task_reservation_updates
-        task_url = "#{workspace_url}/Tasks/**"
-        add_policy(task_url, "POST", nil, {ReservationStatus: REQUIRED})
-      end
-
-      def add_policy(url, method, query_filters = nil, post_filters = nil, allowed = true)
-        policy = {
-          url: url,
-          method: method,
-          query_filter: query_filters || {},
-          post_filter: post_filters || {},
-          allow: allowed
-        }
-
-        @policies.push(policy)
-      end
-
-      def generate_token(ttl = 3600)
-        payload = {
-          iss: @account_sid,
-          exp: (Time.now.to_i + ttl),
-          version: @version,
-          friendly_name: @worker_sid,
-          policies: @policies,
-          account_sid: @account_sid,
-          worker_sid: @worker_sid,
-          channel: @worker_sid,
-          workspace_sid: @workspace_sid
-        }
-
-        JWT.encode payload, @auth_token
-      end
-
-      protected
-
-      def allow_websocket_requests
-        worker_url = "#{TASK_ROUTER_WEBSOCKET_BASE_URL}/#{@account_sid}/#{@worker_sid}"
-        ['GET', 'POST'].each do |meth|
-          add_policy(worker_url, meth)
-        end
-      end
-
-      def allow_activity_list_fetch
-        url = "#{workspace_url}/Activities"
-        add_policy(url, 'GET')
-      end
-
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-module Twilio
-  module Util
-    class AccessToken
-      def initialize(signing_key_id, account_sid, secret, ttl=3600)
-        @signing_key_sid = signing_key_id
-        @account_sid = account_sid
-        @secret = secret
-        @ttl = ttl
-        @grants = []
-      end
-
-      def add_grant(resource, actions=Action::ALL)
-        actions = [*actions]
-        @grants.push({"res" => resource, "act" => actions})
-        self
-      end
-
-      def add_endpoint_grant(endpoint, actions=[Action::Client::LISTEN, Action::Client::INVITE])
-        resource = "sip:#{endpoint}@#{@account_sid}.endpoint.twilio.com"
-        add_grant resource, actions
-      end
-
-      def add_rest_grant(uri, actions=Action::ALL)
-        uri = uri[1..-1] if uri[0] == '/'
-        resource = "https://api.twilio.com/2010-04-01/Accounts/#{@account_sid}/#{uri}"
-        add_grant resource, actions
-      end
-
-      def enable_nts()
-        add_rest_grant('/Tokens', Action::HTTP::POST)
-      end
-
-      def as_jwt()
-        now = Time.now.to_i - 1
-        headers = {
-            'cty' => 'twilio-sat;v=1'
-        }
-        payload = {
-            'jti' => "#{@signing_key_sid}-#{now}",
-            'iss' => @signing_key_sid,
-            'sub' => @account_sid,
-            'nbf' => now,
-            'exp' => now + @ttl,
-            'grants' => @grants
-        }
-        JWT.encode payload, @secret, 'HS256', headers
-      end
-
-      def to_s
-        as_jwt
-      end
-    end
-
-    class Action
-      ALL='*'
-
-      class HTTP
-        DELETE='DELETE'
-        GET='GET'
-        POST='POST'
-        PUT='PUT'
-      end
-
-      class Client
-        LISTEN='listen'
-        INVITE='invite'
-      end
-    end
-  end
-end

data/lib/twilio-ruby/util/client_config.rb

@@ -1,29 +0,0 @@
-module Twilio
-  module Util
-    class ClientConfig
-      DEFAULTS = {
-          host: 'api.twilio.com',
-          port: 443,
-          use_ssl: true,
-          ssl_verify_peer: true,
-          ssl_ca_file: File.dirname(__FILE__) + '/../../../conf/cacert.pem',
-          timeout: 30,
-          proxy_addr: nil,
-          proxy_port: nil,
-          proxy_user: nil,
-          proxy_pass: nil,
-          retry_limit: 1
-      }
-
-      DEFAULTS.each_key do |attribute|
-        attr_accessor attribute
-      end
-
-      def initialize(opts={})
-        DEFAULTS.each do |attribute, value|
-          send("#{attribute}=".to_sym, opts.fetch(attribute, value))
-        end
-      end
-    end
-  end
-end

data/spec/task_router_spec.rb

@@ -1,114 +0,0 @@
-require 'spec_helper'
-
-describe Twilio::TaskRouter::Capability do
-  describe 'with a capability' do
-    before :each do
-      @capability = Twilio::TaskRouter::Capability.new 'AC123', 'foobar', 'WS456', 'WK789'
-    end
-
-    it 'should return a valid jwt when #generate_token is called' do
-      token = @capability.generate_token
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['policies']).not_to be_nil
-      expect(decoded['iss']).not_to be_nil
-      expect(decoded['exp']).not_to be_nil
-    end
-
-    it 'should properly set the iss key in the payload' do
-      token = @capability.generate_token
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['iss']).to eq('AC123')
-    end
-
-    it 'should properly set exp based on the default 1-hour ttl' do
-      seconds = Time.now.to_i
-      token = @capability.generate_token
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['exp']).to eq(seconds + 3600)
-    end
-
-    it 'should properly set exp based on the ttl arg to #generate_token' do
-      seconds = Time.now.to_i
-      ttl = rand 10000
-      token = @capability.generate_token ttl
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['exp']).to eq(seconds + ttl)
-    end
-
-    it 'should allow websocket operations and activity list fetches by default' do
-      token = @capability.generate_token
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['policies'].size).to eq(3)
-      get_policy = {
-        "url" => 'https://event-bridge.twilio.com/v1/wschannels/AC123/WK789',
-        "method" => 'GET',
-        "query_filter" => {},
-        "post_filter" => {},
-        "allow" => true
-      }
-      expect(decoded['policies'][0]).to eq(get_policy)
-      post_policy = {
-        "url" => 'https://event-bridge.twilio.com/v1/wschannels/AC123/WK789',
-        "method" => 'POST',
-        "query_filter" => {},
-        "post_filter" => {},
-        "allow" => true
-      }
-      expect(decoded['policies'][1]).to eq(post_policy)
-
-      activities_policy = {
-        'url' => 'https://taskrouter.twilio.com/v1/Workspaces/WS456/Activities',
-        'method' => 'GET',
-        'query_filter' => {},
-        'post_filter' => {},
-        'allow' => true
-      }
-      expect(decoded['policies'][2]).to eq(activities_policy)
-    end
-
-    it 'should add a policy when #allow_worker_activity_updates is called' do
-      @capability.allow_worker_activity_updates
-      token = @capability.generate_token
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['policies'].size).to eq(4)
-      activity_policy = {
-        'url' => 'https://taskrouter.twilio.com/v1/Workspaces/WS456/Workers/WK789',
-        'method' => 'POST',
-        'query_filter' => {},
-        'post_filter' => {'ActivitySid' => {'required' => true}},
-        'allow' => true
-      }
-      expect(decoded['policies'][-1]).to eq(activity_policy)
-    end
-
-    it 'should add a policy when #allow_worker_fetch_attributes is called' do
-      @capability.allow_worker_fetch_attributes
-      token = @capability.generate_token
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['policies'].size).to eq(4)
-      worker_policy = {
-        'url' => 'https://taskrouter.twilio.com/v1/Workspaces/WS456/Workers/WK789',
-        'method' => 'GET',
-        'query_filter' => {},
-        'post_filter' => {},
-        'allow' => true
-      }
-      expect(decoded['policies'][-1]).to eq(worker_policy)
-    end
-
-    it 'should add a policy when #allow_task_reservation_updates is called' do
-      @capability.allow_task_reservation_updates
-      token = @capability.generate_token
-      decoded, header = JWT.decode token, 'foobar'
-      expect(decoded['policies'].size).to eq(4)
-      task_policy = {
-        'url' => 'https://taskrouter.twilio.com/v1/Workspaces/WS456/Tasks/**',
-        'method' => 'POST',
-        'query_filter' => {},
-        'post_filter' => {'ReservationStatus' => {'required' => true}},
-        'allow' => true
-      }
-      expect(decoded['policies'][-1]).to eq(task_policy)
-    end
-  end
-end

data/spec/util/access_token_spec.rb

@@ -1,103 +0,0 @@
-require 'spec_helper'
-
-describe Twilio::Util::AccessToken do
-
-  it 'should generate a token for no grants' do
-    scat = Twilio::Util::AccessToken.new 'SK123', 'AC123', 'secret'
-    token = scat.to_s
-    expect(token).not_to be_nil
-    payload, header = JWT.decode token, 'secret'
-
-    expect(payload['iss']).to eq('SK123')
-    expect(payload['sub']).to eq('AC123')
-    expect(payload['nbf']).not_to be_nil
-    expect(payload['exp']).not_to be_nil
-    expect(payload['nbf'] + 3600).to eq(payload['exp'])
-    expect(payload['jti']).not_to be_nil
-    expect("#{payload['iss']}-#{payload['nbf']}").to eq(payload['jti'])
-    expect(payload['grants']).not_to be_nil
-    expect(payload['grants'].count).to eq(0)
-  end
-
-  it 'should be able to add standard grants' do
-    scat = Twilio::Util::AccessToken.new 'SK123', 'AC123', 'secret'
-    scat.add_grant 'https://api.twilio.com/**'
-    token = scat.to_s
-    expect(token).not_to be_nil
-    payload, header = JWT.decode token, 'secret'
-
-    expect(payload['iss']).to eq('SK123')
-    expect(payload['sub']).to eq('AC123')
-    expect(payload['nbf']).not_to be_nil
-    expect(payload['exp']).not_to be_nil
-    expect(payload['nbf'] + 3600).to eq(payload['exp'])
-    expect(payload['jti']).not_to be_nil
-    expect("#{payload['iss']}-#{payload['nbf']}").to eq(payload['jti'])
-    expect(payload['grants']).not_to be_nil
-    expect(payload['grants'].count).to eq(1)
-    expect(payload['grants'][0]['res']).to eq('https://api.twilio.com/**')
-    expect(payload['grants'][0]['act']).to eq(['*'])
-  end
-
-  it 'should be able to add endpoint grants' do
-    scat = Twilio::Util::AccessToken.new 'SK123', 'AC123', 'secret'
-    scat.add_endpoint_grant 'bob'
-    token = scat.to_s
-    expect(token).not_to be_nil
-    payload, header = JWT.decode token, 'secret'
-
-    expect(payload['iss']).to eq('SK123')
-    expect(payload['sub']).to eq('AC123')
-    expect(payload['nbf']).not_to be_nil
-    expect(payload['exp']).not_to be_nil
-    expect(payload['nbf'] + 3600).to eq(payload['exp'])
-    expect(payload['jti']).not_to be_nil
-    expect("#{payload['iss']}-#{payload['nbf']}").to eq(payload['jti'])
-    expect(payload['grants']).not_to be_nil
-    expect(payload['grants'].count).to eq(1)
-    expect(payload['grants'][0]['res']).to eq('sip:bob@AC123.endpoint.twilio.com')
-    expect(payload['grants'][0]['act']).to eq([Twilio::Util::Action::Client::LISTEN, Twilio::Util::Action::Client::INVITE])
-  end
-
-  it 'should be able to add rest grants' do
-    scat = Twilio::Util::AccessToken.new 'SK123', 'AC123', 'secret'
-    scat.add_rest_grant 'Apps'
-    token = scat.to_s
-    expect(token).not_to be_nil
-    payload, header = JWT.decode token, 'secret'
-
-    expect(payload['iss']).to eq('SK123')
-    expect(payload['sub']).to eq('AC123')
-    expect(payload['nbf']).not_to be_nil
-    expect(payload['exp']).not_to be_nil
-    expect(payload['nbf'] + 3600).to eq(payload['exp'])
-    expect(payload['jti']).not_to be_nil
-    expect("#{payload['iss']}-#{payload['nbf']}").to eq(payload['jti'])
-    expect(payload['grants']).not_to be_nil
-    expect(payload['grants'].count).to eq(1)
-    expect(payload['grants'][0]['res']).to eq('https://api.twilio.com/2010-04-01/Accounts/AC123/Apps')
-    expect(payload['grants'][0]['act']).to eq([Twilio::Util::Action::ALL])
-  end
-
-  it 'should be able to enable NTS' do
-    scat = Twilio::Util::AccessToken.new 'SK123', 'AC123', 'secret'
-    scat.enable_nts
-    token = scat.to_s
-    expect(token).not_to be_nil
-    payload, header = JWT.decode token, 'secret'
-
-    expect(payload['iss']).to eq('SK123')
-    expect(payload['sub']).to eq('AC123')
-    expect(payload['nbf']).not_to be_nil
-    expect(payload['exp']).not_to be_nil
-    expect(payload['nbf'] + 3600).to eq(payload['exp'])
-    expect(payload['jti']).not_to be_nil
-    expect("#{payload['iss']}-#{payload['nbf']}").to eq(payload['jti'])
-    expect(payload['grants']).not_to be_nil
-    expect(payload['grants'].count).to eq(1)
-    expect(payload['grants'][0]['res']).to eq('https://api.twilio.com/2010-04-01/Accounts/AC123/Tokens')
-    expect(payload['grants'][0]['act']).to eq([Twilio::Util::Action::HTTP::POST])
-  end
-
-
-end

data/spec/util/client_config_spec.rb

@@ -1,21 +0,0 @@
-require 'spec_helper'
-
-describe Twilio::Util::ClientConfig do
-  Twilio::Util::ClientConfig::DEFAULTS.each do |attribute, value|
-    it "sets an attribute with a default value" do
-      config = Twilio::Util::ClientConfig.new
-      expect(config.send(attribute)).to eq(value)
-    end
-
-    it "can update the value for the attribute" do
-      config = Twilio::Util::ClientConfig.new
-      config.send("#{attribute}=", "blah")
-      expect(config.send(attribute)).to eq("blah")
-    end
-
-    it "can set the value from a hash in the initializer" do
-      config = Twilio::Util::ClientConfig.new(attribute => 'blah')
-      expect(config.send(attribute)).to eq("blah")
-    end
-  end
-end