twilio-ruby 5.0.0.alpha1 → 5.0.0.rc2

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

@@ -0,0 +1,87 @@
+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/twiml/response.rb

@@ -0,0 +1,16 @@
+module Twilio
+  module TwiML
+    class Response
+
+      attr_reader :text
+      alias_method :to_xml , :text
+
+      def initialize(&block)
+        xml = Builder::XmlMarkup.new
+        xml.instruct!
+        @text = xml.Response &block
+      end
+
+    end
+  end
+end

data/lib/twilio-ruby/util.rb

@@ -1,7 +1,7 @@
 module Twilio
   module Util
     def url_encode(hash)
-      hash.to_a.map { |p| p.map { |e| CGI.escape get_string(e) }.join '=' }.join '&'
+      hash.to_a.map {|p| p.map {|e| CGI.escape get_string(e)}.join '='}.join '&'
     end
 
     def get_string(obj)

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

@@ -0,0 +1,70 @@
+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/capability.rb

@@ -0,0 +1,64 @@
+module Twilio
+  module Util
+    class Capability
+
+      include Twilio::Util
+
+      def initialize(account_sid = nil, auth_token = nil)
+        @account_sid = account_sid || Twilio.account_sid
+        @auth_token = auth_token || Twilio.auth_token
+        if @account_sid.nil? || @auth_token.nil?
+          raise ArgumentError, 'Account SID and auth token are required'
+        end
+        @capabilities = []
+      end
+
+      def allow_client_incoming(client_name)
+        @client_name = client_name # stash for use in outgoing
+        scope_params = { 'clientName' => client_name }
+        @capabilities << scope_uri_for('client', 'incoming', scope_params)
+      end
+
+      def allow_client_outgoing(app_sid, params = {})
+        @allow_client_outgoing = true
+        @outgoing_scope_params = { 'appSid' => app_sid }
+        unless params.empty?
+          @outgoing_scope_params['appParams'] = url_encode params
+        end
+      end
+
+      def allow_event_stream(filters = {})
+        scope_params = { 'path' => '/2010-04-01/Events' }
+        scope_params['params'] = filters unless filters.empty?
+        @capabilities << scope_uri_for('stream', 'subscribe', scope_params)
+      end
+
+      def scope_uri_for(service, privilege, params = {})
+        scope_uri = "scope:#{service}:#{privilege}"
+        scope_uri << "?#{url_encode(params)}" unless params.empty?
+      end
+
+      def generate(ttl = 3600)
+
+        capabilities = @capabilities.clone # we need a local copy to work on
+
+        # build the outgoing scope lazily so that we can use @client_name
+        if @allow_client_outgoing
+          params = @outgoing_scope_params
+          params.merge!('clientName' => @client_name) if @client_name
+          capabilities << scope_uri_for('client', 'outgoing', params)
+        end
+
+        payload = {
+          'scope' => capabilities.join(' '),
+          'iss' => @account_sid,
+          'exp' => (Time.now.to_i + ttl),
+        }
+
+        JWT.encode payload, @auth_token
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+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/lib/twilio-ruby/{security → util}/request_validator.rb

@@ -1,14 +1,14 @@
 module Twilio
-  module Security
+  module Util
     class RequestValidator
+
       def initialize(auth_token = nil)
         @auth_token = auth_token || Twilio.auth_token
         raise ArgumentError, 'Auth token is required' if @auth_token.nil?
       end
 
       def validate(url, params, signature)
-        params_hash = params_to_hash(params)
-        expected = build_signature_for(url, params_hash)
+        expected = build_signature_for url, params
         secure_compare(expected, signature)
       end
 
@@ -30,24 +30,7 @@ module Twilio
 
         res = 0
         b.each_byte { |byte| res |= byte ^ l.shift }
-        res.zero?
-      end
-
-      # `ActionController::Parameters` no longer, as of Rails 5, inherits
-      # from `Hash` so the `sort` method, used above in `build_signature_for`
-      # is deprecated.
-      #
-      # `to_unsafe_h` was introduced in Rails 4.2.1, before then it is still
-      # possible to sort on an ActionController::Parameters object.
-      #
-      # We use `to_unsafe_h` as `to_h` returns a hash of the permitted
-      # parameters only and we need all the parameters to create the signature.
-      def params_to_hash(params)
-        if params.respond_to?(:to_unsafe_h)
-          params.to_unsafe_h
-        else
-          params
-        end
+        res == 0
       end
     end
   end

data/lib/twilio-ruby/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-  VERSION = '5.0.0.alpha1'.freeze
+  VERSION = '5.0.0.rc2'
 end

data/spec/holodeck/holodeck.rb

@@ -21,10 +21,10 @@ class Holodeck
     end
 
     def ==(other)
-      method.casecmp(other.method.upcase).zero? &&
-        url == other.url &&
-        params == other.params &&
-        data == other.data
+      method.upcase == other.method.upcase &&
+      url == other.url &&
+      params == other.params &&
+      data == other.data
     end
 
     def to_s
@@ -43,7 +43,7 @@ class Holodeck
     @response = response
   end
 
-  def request(host, port, method, url, params = {}, data = {}, headers = {}, auth = nil, _timeout = nil)
+  def request(host, port, method, url, params={}, data={}, headers={}, auth=nil, timeout=nil)
     @requests << Request.new(
       method: method,
       url: url,
@@ -52,7 +52,7 @@ class Holodeck
       headers: headers,
       auth: auth
     )
-    @response
+    return @response
   end
 
   def has_request?(request)

data/spec/holodeck/hologram.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'uri'
 
 class Hologram

data/spec/integration/api/v2010/account/address/dependent_phone_number_spec.rb

@@ -2,20 +2,20 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#       /       /       
 
 require 'spec_helper.rb'
 
 describe 'DependentPhoneNumber' do
   it "can read" do
     @holodeck.mock(Twilio::TwilioResponse.new(500, ''))
-
+    
     expect {
       @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                        .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                        .dependent_phone_numbers.list()
-    }.to raise_exception(Twilio::REST::TwilioError)
-
+    }.to raise_exception(Twilio::REST::TwilioException)
+    
     values = {}
     expect(
     @holodeck.has_request?(Holodeck::Request.new(
@@ -57,11 +57,11 @@ describe 'DependentPhoneNumber' do
       }
       ]
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .dependent_phone_numbers.list()
-
+    
     expect(actual).to_not eq(nil)
   end
 
@@ -80,11 +80,11 @@ describe 'DependentPhoneNumber' do
       }
       ]
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .dependent_phone_numbers.list()
-
+    
     expect(actual).to_not eq(nil)
   end
 end

data/spec/integration/api/v2010/account/address_spec.rb

@@ -2,19 +2,19 @@
 # This code was generated by
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#       /       /       
 
 require 'spec_helper.rb'
 
 describe 'Address' do
   it "can create" do
     @holodeck.mock(Twilio::TwilioResponse.new(500, ''))
-
+    
     expect {
       @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                        .addresses.create(customer_name: "customer_name", street: "street", city: "city", region: "region", postal_code: "postal_code", iso_country: "US")
-    }.to raise_exception(Twilio::REST::TwilioError)
-
+    }.to raise_exception(Twilio::REST::TwilioException)
+    
     values = {
         'CustomerName' => "customer_name",
         'Street' => "street",
@@ -33,7 +33,7 @@ describe 'Address' do
 
   it "receives create responses" do
     @holodeck.mock(Twilio::TwilioResponse.new(
-        201,
+        200,
       %q[
       {
           "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
@@ -41,33 +41,31 @@ describe 'Address' do
           "customer_name": "name",
           "date_created": "Tue, 18 Aug 2015 17:07:30 +0000",
           "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",
-          "emergency_enabled": false,
           "friendly_name": null,
           "iso_country": "US",
           "postal_code": "94019",
           "region": "CA",
           "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
           "street": "4th",
-          "validated": false,
           "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
       }
       ]
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses.create(customer_name: "customer_name", street: "street", city: "city", region: "region", postal_code: "postal_code", iso_country: "US")
-
+    
     expect(actual).to_not eq(nil)
   end
 
   it "can delete" do
     @holodeck.mock(Twilio::TwilioResponse.new(500, ''))
-
+    
     expect {
       @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                        .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").delete()
-    }.to raise_exception(Twilio::REST::TwilioError)
-
+    }.to raise_exception(Twilio::REST::TwilioException)
+    
     values = {}
     expect(
     @holodeck.has_request?(Holodeck::Request.new(
@@ -81,21 +79,21 @@ describe 'Address' do
         204,
       nil,
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").delete()
-
+    
     expect(actual).to eq(true)
   end
 
   it "can fetch" do
     @holodeck.mock(Twilio::TwilioResponse.new(500, ''))
-
+    
     expect {
       @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                        .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").fetch()
-    }.to raise_exception(Twilio::REST::TwilioError)
-
+    }.to raise_exception(Twilio::REST::TwilioException)
+    
     values = {}
     expect(
     @holodeck.has_request?(Holodeck::Request.new(
@@ -114,33 +112,31 @@ describe 'Address' do
           "customer_name": "name",
           "date_created": "Tue, 18 Aug 2015 17:07:30 +0000",
           "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",
-          "emergency_enabled": false,
           "friendly_name": null,
           "iso_country": "US",
           "postal_code": "94019",
           "region": "CA",
           "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
           "street": "4th",
-          "validated": false,
           "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
       }
       ]
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").fetch()
-
+    
     expect(actual).to_not eq(nil)
   end
 
   it "can update" do
     @holodeck.mock(Twilio::TwilioResponse.new(500, ''))
-
+    
     expect {
       @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                        .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").update()
-    }.to raise_exception(Twilio::REST::TwilioError)
-
+    }.to raise_exception(Twilio::REST::TwilioException)
+    
     values = {}
     expect(
     @holodeck.has_request?(Holodeck::Request.new(
@@ -159,33 +155,31 @@ describe 'Address' do
           "customer_name": "name",
           "date_created": "Tue, 18 Aug 2015 17:07:30 +0000",
           "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",
-          "emergency_enabled": false,
           "friendly_name": null,
           "iso_country": "US",
           "postal_code": "94019",
           "region": "CA",
           "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
           "street": "4th",
-          "validated": false,
           "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
       }
       ]
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses("ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa").update()
-
+    
     expect(actual).to_not eq(nil)
   end
 
   it "can read" do
     @holodeck.mock(Twilio::TwilioResponse.new(500, ''))
-
+    
     expect {
       @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                        .addresses.list()
-    }.to raise_exception(Twilio::REST::TwilioError)
-
+    }.to raise_exception(Twilio::REST::TwilioException)
+    
     values = {}
     expect(
     @holodeck.has_request?(Holodeck::Request.new(
@@ -206,14 +200,12 @@ describe 'Address' do
                   "customer_name": "name",
                   "date_created": "Tue, 18 Aug 2015 17:07:30 +0000",
                   "date_updated": "Tue, 18 Aug 2015 17:07:30 +0000",
-                  "emergency_enabled": false,
                   "friendly_name": null,
                   "iso_country": "US",
                   "postal_code": "94019",
                   "region": "CA",
                   "sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                   "street": "4th",
-                  "validated": false,
                   "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Addresses/ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
               }
           ],
@@ -231,10 +223,10 @@ describe 'Address' do
       }
       ]
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses.list()
-
+    
     expect(actual).to_not eq(nil)
   end
 
@@ -258,10 +250,10 @@ describe 'Address' do
       }
       ]
     ))
-
+    
     actual = @client.api.v2010.accounts("ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa") \
                               .addresses.list()
-
+    
     expect(actual).to_not eq(nil)
   end
 end