twilio-ruby 3.15.0 → 3.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e3f7fccd86f4d886d36e894f065fc04e8959589
-  data.tar.gz: 1ee5bcddb4df870adcd8ee40d490a8509dae1c94
+  metadata.gz: fbf01b84361cd43929e39a6edee180274f39e52a
+  data.tar.gz: c88951b668570f7c2cf9eb5bce608917366357ea
 SHA512:
-  metadata.gz: 568a300bd1658267aaee702e1f8d35f44245ede4c18de5ee8ec67f6f62834a232941697f18cfc2841a673d13c7d0782c8654b470a1c801303c8f4fc50d7b27cd
-  data.tar.gz: a92cf749d641e562618dade1c21a80bb9dd2d8e48747e96b3a47b9432f0d581455583f19cc57e0a1f916a0fab2b5c7faff3d55d9fed73f7cf75adc2f239a4a2f
+  metadata.gz: 24a085c8ac996ba2b85848babda9246f5bffcdd378e73122884efbfc6dfa3506cd4cb47bb42bb3bb9a1d9cfa990e7b30c9a2e2b913da2b0bde9094fdd112d47c
+  data.tar.gz: 6495299185882caa6eeb2797b2f12863c1bc9e4d64aa24a643107ecf80d0b93627831d41f9d867a755ee9c1d68d96db7938cd9bc62f89578fde617456ca42efd

data/CHANGES.md

@@ -1,6 +1,13 @@
 twilio-ruby changelog
 =====================
 
+Version 3.15.1
+--------------
+
+Released February 18, 2015
+
+- For real this time, add TaskRouterClient object and resources for new TaskRouter API
+
 Version 3.15.0
 --------------
 

data/lib/twilio-ruby/rest/client.rb

@@ -1,5 +1,116 @@
 module Twilio
   module REST
+    class BaseClient
+      include Twilio::Util
+      include Twilio::REST::Utils
+
+      HTTP_HEADERS = {
+          'Accept' => 'application/json',
+          'Accept-Charset' => 'utf-8',
+          'User-Agent' => "twilio-ruby/#{Twilio::VERSION}" \
+                        " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" \
+                        " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
+      }
+
+      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
+      }
+
+      attr_reader :account_sid, :last_request, :last_response
+
+      def initialize(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        @config = get_defaults.merge! options
+
+        @account_sid = args[0] || Twilio.account_sid
+        @auth_token = args[1] || Twilio.auth_token
+        if @account_sid.nil? || @auth_token.nil?
+          raise ArgumentError, 'Account SID and auth token are required'
+        end
+
+        set_up_connection
+        set_up_subresources
+      end
+
+      protected
+
+      ##
+      # Get the default config values.
+      def get_defaults
+        # To be overridden
+        DEFAULTS
+      end
+
+      ##
+      # Set up and cache a Net::HTTP object to use when making requests. This is
+      # a private method documented for completeness.
+      def set_up_connection # :doc:
+        connection_class = Net::HTTP::Proxy @config[:proxy_addr],
+                                            @config[:proxy_port], @config[:proxy_user], @config[:proxy_pass]
+        @connection = connection_class.new @config[:host], @config[:port]
+        set_up_ssl
+        @connection.open_timeout = @config[:timeout]
+        @connection.read_timeout = @config[:timeout]
+      end
+
+      ##
+      # Set up the ssl properties of the <tt>@connection</tt> Net::HTTP object.
+      # This is a private method documented for completeness.
+      def set_up_ssl # :doc:
+        @connection.use_ssl = @config[:use_ssl]
+        if @config[:ssl_verify_peer]
+          @connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          @connection.ca_file = @config[:ssl_ca_file]
+        else
+          @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+
+      ##
+      # Set up sub resources attributes.
+      def set_up_subresources # :doc:
+        # To be overridden
+      end
+
+      ##
+      # Send an HTTP request using the cached <tt>@connection</tt> object and
+      # return the JSON response body parsed into a hash. Also save the raw
+      # Net::HTTP::Request and Net::HTTP::Response objects as
+      # <tt>@last_request</tt> and <tt>@last_response</tt> to allow for
+      # inspection later.
+      def connect_and_send(request) # :doc:
+        @last_request = request
+        retries_left = @config[:retry_limit]
+        begin
+          response = @connection.request request
+          @last_response = response
+          if response.kind_of? Net::HTTPServerError
+            raise Twilio::REST::ServerError
+          end
+        rescue Exception
+          raise if request.class == Net::HTTP::Post
+          if retries_left > 0 then retries_left -= 1; retry else raise end
+        end
+        if response.body and !response.body.empty?
+          object = MultiJson.load response.body
+        end
+        if response.kind_of? Net::HTTPClientError
+          raise Twilio::REST::RequestError.new object['message'], object['code']
+        end
+        object
+      end
+    end
+
     ##
     # The Twilio::REST::Client class caches authentication parameters and
     # exposes methods to make HTTP requests to Twilio's REST API. However, you
@@ -47,36 +158,10 @@ module Twilio
     # methods like ListResource#list to return a (possibly filtered) list of
     # accounts and ListResource#create to create a new account. Use
     # ListResource#get to grab a particular account once you know its sid.
-    class Client
-      include Twilio::Util
-      include Twilio::REST::Utils
-
+    class Client < BaseClient
       API_VERSION = '2010-04-01'
 
-      HTTP_HEADERS = {
-        'Accept' => 'application/json',
-        'Accept-Charset' => 'utf-8',
-        'User-Agent' => "twilio-ruby/#{Twilio::VERSION}" \
-                        " (#{RUBY_ENGINE}/#{RUBY_PLATFORM}" \
-                        " #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL})"
-      }
-
-      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
-      }
-
-      attr_reader :account_sid, :account, :accounts, :last_request,
-        :last_response
+      attr_reader :account, :accounts
 
       ##
       # Instantiate a new HTTP client to talk to Twilio. The parameters
@@ -145,17 +230,7 @@ module Twilio
       # The number of times to retry a request that has failed before throwing
       # an exception. Defaults to one.
       def initialize(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        @config = DEFAULTS.merge! options
-
-        @account_sid = args[0] || Twilio.account_sid
-        @auth_token = args[1] || Twilio.auth_token
-        if @account_sid.nil? || @auth_token.nil?
-          raise ArgumentError, 'Account SID and auth token are required'
-        end
-
-        set_up_connection
-        set_up_subresources
+        super(*args)
       end
 
       def inspect # :nodoc:
@@ -202,67 +277,225 @@ module Twilio
         end
       end
 
-      private
+      protected
 
       ##
-      # Set up and cache a Net::HTTP object to use when making requests. This is
-      # a private method documented for completeness.
-      def set_up_connection # :doc:
-        connection_class = Net::HTTP::Proxy @config[:proxy_addr],
-          @config[:proxy_port], @config[:proxy_user], @config[:proxy_pass]
-        @connection = connection_class.new @config[:host], @config[:port]
-        set_up_ssl
-        @connection.open_timeout = @config[:timeout]
-        @connection.read_timeout = @config[:timeout]
+      # Set up +account+ and +accounts+ attributes.
+      def set_up_subresources # :doc:
+        @accounts = Twilio::REST::Accounts.new "/#{API_VERSION}/Accounts", self
+        @account = @accounts.get @account_sid
       end
+    end
+
+    class TaskRouterClient < BaseClient
+      API_VERSION = 'v1'
+
+      DEFAULTS = {
+          host: 'taskrouter.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
+      }
+
+      attr_reader :workspace, :workspace_sid, :workspaces
 
       ##
-      # Set up the ssl properties of the <tt>@connection</tt> Net::HTTP object.
-      # This is a private method documented for completeness.
-      def set_up_ssl # :doc:
-        @connection.use_ssl = @config[:use_ssl]
-        if @config[:ssl_verify_peer]
-          @connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
-          @connection.ca_file = @config[:ssl_ca_file]
-        else
-          @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      # Instantiate a new HTTP TaskRouter client to talk to Twilio. The parameters
+      # +account_sid+, +auth_token+ and +workspace_sid are required, unless you
+      # have configured them already using the block configure syntax, and used
+      # to generate the HTTP basic auth header in each request. The +options+
+      # parameter is a hash of connection configuration options. the following
+      # keys are supported:
+      #
+      # === <tt>host: 'taskrouter.twilio.com'</tt>
+      #
+      # The domain to which you'd like the client to make HTTP requests. Useful
+      # for testing. Defaults to 'api.twilio.com'.
+      #
+      # === <tt>port: 443</tt>
+      #
+      # The port on which to connect to the above domain. Defaults to 443 and
+      # should be left that way except in testing environments.
+      #
+      # === <tt>use_ssl: true</tt>
+      #
+      # Declare whether ssl should be used for connections to the above domain.
+      # Defaults to true and should be left alone except when testing.
+      #
+      # === <tt>ssl_verify_peer: true</tt>
+      #
+      # Declare whether to verify the host's ssl cert when setting up the
+      # connection to the above domain. Defaults to true, but can be turned off
+      # to avoid ssl certificate verification failures in environments without
+      # the necessary ca certificates.
+      #
+      # === <tt>ssl_ca_file: '/path/to/ca/file'</tt>
+      #
+      # Specify the path to the certificate authority bundle you'd like to use
+      # to verify Twilio's SSL certificate on each request. If not specified, a
+      # certificate bundle extraced from Firefox is packaged with the gem and
+      # used by default.
+      #
+      # === <tt>timeout: 30</tt>
+      #
+      # Set the time in seconds to wait before timing out the HTTP request.
+      # Defaults to 30 seconds. If you aren't fetching giant pages of call or
+      # SMS logs you can safely decrease this to something like 3 seconds or
+      # lower. In paricular if you are sending SMS you can set this to 1 second
+      # or less and swallow the exception if you don't care about the response.
+      #
+      # === <tt>proxy_addr: 'proxy.host.domain'</tt>
+      #
+      # The domain of a proxy through which you'd like the client to make HTTP
+      # requests. Defaults to nil.
+      #
+      # === <tt>proxy_port: 3128</tt>
+      #
+      # The port on which to connect to the above proxy. Defaults to nil.
+      #
+      # === <tt>proxy_user: 'username'</tt>
+      #
+      # The user name to use for authentication with the proxy. Defaults to nil.
+      #
+      # === <tt>proxy_pass: 'password'</tt>
+      #
+      # The password to use for authentication with the proxy. Defaults to nil.
+      #
+      # === <tt>retry_limit: 1</tt>
+      #
+      # The number of times to retry a request that has failed before throwing
+      # an exception. Defaults to one.
+      def initialize(*args)
+        @workspace_sid = args[2]
+        if @workspace_sid.nil?
+          raise ArgumentError, 'Workspace SID is required'
         end
+        super(*args)
       end
 
       ##
-      # Set up +account+ and +accounts+ attributes.
-      def set_up_subresources # :doc:
-        @accounts = Twilio::REST::Accounts.new "/#{API_VERSION}/Accounts", self
-        @account = @accounts.get @account_sid
+      # Define #get, #put, #post and #delete helper methods for sending HTTP
+      # requests to Twilio. You shouldn't need to use these methods directly,
+      # but they can be useful for debugging. Each method returns a hash
+      # obtained from parsing the JSON object in the response body.
+      [:get, :put, :post, :delete].each do |method|
+        method_class = Net::HTTP.const_get method.to_s.capitalize
+        define_method method do |path, *args|
+          params = twilify args[0]; params = {} if params.empty?
+          unless args[1] # build the full path unless already given
+            path = path.dup
+            path << "?#{url_encode(params)}" if method == :get && !params.empty?
+          end
+          request = method_class.new path, HTTP_HEADERS
+          request.basic_auth @account_sid, @auth_token
+          request.form_data = params if [:post, :put].include? method
+          connect_and_send request
+        end
+      end
+
+      def inspect # :nodoc:
+        "<Twilio::REST::TaskRouterClient @account_sid=#{@account_sid}>"
       end
 
       ##
-      # Send an HTTP request using the cached <tt>@connection</tt> object and
-      # return the JSON response body parsed into a hash. Also save the raw
-      # Net::HTTP::Request and Net::HTTP::Response objects as
-      # <tt>@last_request</tt> and <tt>@last_response</tt> to allow for
-      # inspection later.
-      def connect_and_send(request) # :doc:
-        @last_request = request
-        retries_left = @config[:retry_limit]
-        begin
-          response = @connection.request request
-          @last_response = response
-          if response.kind_of? Net::HTTPServerError
-            raise Twilio::REST::ServerError
-          end
-        rescue Exception
-          raise if request.class == Net::HTTP::Post
-          if retries_left > 0 then retries_left -= 1; retry else raise end
+      # Delegate workspace methods from the client. This saves having to call
+      # <tt>client.workspace</tt> every time for resources on the default
+      # workspace.
+      def method_missing(method_name, *args, &block)
+        if workspace.respond_to?(method_name)
+          workspace.send(method_name, *args, &block)
+        else
+          super
         end
-        if response.body and !response.body.empty?
-          object = MultiJson.load response.body
+      end
+
+      def respond_to?(method_name, include_private=false)
+        if workspace.respond_to?(method_name, include_private)
+          true
+        else
+          super
         end
-        if response.kind_of? Net::HTTPClientError
-          raise Twilio::REST::RequestError.new object['message'], object['code']
+      end
+
+      ##
+      # Get statistics of a task queue.
+      def task_queue_statistics(task_queue_sid, *args) # :doc:
+        if task_queue_sid.nil?
+          raise ArgumentError, 'Task queue SID is required'
         end
-        object
+        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/TaskQueues/#{task_queue_sid}/Statistics"
+        response = get path, args, true
+        Twilio::REST::TaskRouter::TaskQueueStatistics.new path, self, response
+      end
+
+      ##
+      # Get statistics of task queues.
+      def task_queues_statistics(*args) # :doc:
+        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/TaskQueues/Statistics"
+        stats = Twilio::REST::TaskRouter::TaskQueuesStatistics.new path, self
+        stats.list args, true
+      end
+
+      ##
+      # Get statistics of a worker.
+      def worker_statistics(worker_sid, *args) # :doc:
+        if worker_sid.nil?
+          raise ArgumentError, 'Worker SID is required'
+        end
+        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Workers/#{worker_sid}/Statistics"
+        response = get path, args, true
+        Twilio::REST::TaskRouter::WorkerStatistics.new path, self, response
+      end
+
+      ##
+      # Get statistics of workers.
+      def workers_statistics(*args) # :doc:
+        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Workers/Statistics"
+        response = get path, args, true
+        Twilio::REST::TaskRouter::WorkersStatistics.new path, self, response
+      end
+
+      ##
+      # Get statistics of a workflow.
+      def workflow_statistics(workflow_sid, *args) # :doc:
+        if workflow_sid.nil?
+          raise ArgumentError, 'Workflow SID is required'
+        end
+        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Workflows/#{workflow_sid}/Statistics"
+        response = get path, args, true
+        Twilio::REST::TaskRouter::WorkflowStatistics.new path, self, response
       end
+
+      ##
+      # Get statistics of a workspace.
+      def workspace_statistics(*args) # :doc:
+        path = "/#{API_VERSION}/Workspaces/#{@workspace_sid}/Statistics"
+        response = get path, args, true
+        Twilio::REST::TaskRouter::WorkspaceStatistics.new path, self, response
+      end
+
+      protected
+
+      ##
+      # Get the default config values.
+      def get_defaults
+        DEFAULTS
+      end
+
+      ##
+      # Set up +workspace+ and +workspaces+ attributes.
+      def set_up_subresources # :doc:
+        @workspaces = Twilio::REST::TaskRouter::Workspaces.new "/#{API_VERSION}/Workspaces", self
+        @workspace = @workspaces.get @workspace_sid
+      end
+
     end
   end
 end

data/lib/twilio-ruby/rest/list_resource.rb

@@ -5,6 +5,7 @@ module Twilio
 
       def initialize(path, client)
         custom_names = {
+          'Activities' => 'Activity',
           'Media' => 'MediaInstance',
           'IpAddresses' => 'IpAddress',
           'Feedback' => 'FeedbackInstance',

data/lib/twilio-ruby/rest/next_gen_list_resource.rb

@@ -0,0 +1,29 @@
+module Twilio
+  module REST
+    class NextGenListResource < Twilio::REST::ListResource
+      def list(params={}, full_path=false)
+        raise "Can't get a resource list without a REST Client" unless @client
+        response = @client.get @path, params, full_path
+        list_key = response['meta']['key']
+        raise "Couldn't find a list key in response meta" unless list_key
+        resources = response[list_key]
+        resource_list = resources.map do |resource|
+          @instance_class.new "#{@path}/#{resource[@instance_id_key]}", @client,
+                              resource
+        end
+        client, list_class = @client, self.class
+        resource_list.instance_eval do
+          eigenclass = class << self; self; end
+          eigenclass.send :define_method, :next_page, &lambda {
+            if response['meta']['next_page_url']
+              list_class.new(response['meta']['next_page_url'], client).list({})
+            else
+              []
+            end
+          }
+        end
+        resource_list
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/activities.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Activities < Twilio::REST::NextGenListResource; end
+      class Activity < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/events.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Events < ListResource; end
+      class Event < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/reservations.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Reservations < Twilio::REST::NextGenListResource; end
+      class Reservation < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/task_queues.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class TaskQueues < Twilio::REST::NextGenListResource; end
+      class TaskQueue < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/task_queues_statistics.rb

@@ -0,0 +1,15 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class TaskQueuesStatistics < Twilio::REST::NextGenListResource
+        def initialize(path, client)
+          @path, @client = path, client
+          @instance_class = Twilio::REST::TaskRouter::TaskQueueStatistics
+          @list_key, @instance_id_key = 'task_queues_statistics', 'task_queue_sid'
+        end
+      end
+
+      class TaskQueueStatistics < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/tasks.rb

@@ -0,0 +1,15 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Tasks < Twilio::REST::NextGenListResource; end
+
+      class Task < InstanceResource
+        def initialize(path, client, params={})
+          super path, client, params
+          @submodule = :TaskRouter
+          resource :reservations
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/workers.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Workers < Twilio::REST::NextGenListResource; end
+      class Worker < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/workers_statistics.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class WorkersStatistics < Twilio::REST::InstanceResource; end
+      class WorkerStatistics < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/workflow_statistics.rb

@@ -0,0 +1,7 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class WorkflowStatistics < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/workflows.rb

@@ -0,0 +1,8 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Workflows < Twilio::REST::NextGenListResource; end
+      class Workflow < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/workspace_statistics.rb

@@ -0,0 +1,7 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class WorkspaceStatistics < InstanceResource; end
+    end
+  end
+end

data/lib/twilio-ruby/rest/task_router/workspaces.rb

@@ -0,0 +1,15 @@
+module Twilio
+  module REST
+    module TaskRouter
+      class Workspaces < Twilio::REST::NextGenListResource; end
+
+      class Workspace < InstanceResource
+        def initialize(path, client, params={})
+          super path, client, params
+          @submodule = :TaskRouter
+          resource :activities, :events, :task_queues, :tasks, :workers, :workflows
+        end
+      end
+    end
+  end
+end

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/version.rb

@@ -1,3 +1,3 @@
 module Twilio
-  VERSION = '3.15.0'
+  VERSION = '3.15.1'
 end

data/lib/twilio-ruby.rb

@@ -14,9 +14,12 @@ require 'twilio-ruby/util/configuration'
 require 'twilio-ruby/util/request_validator'
 require 'twilio-ruby/util/capability'
 require 'twilio-ruby/twiml/response'
+require 'twilio-ruby/task_router'
+require 'twilio-ruby/task_router/capability'
 require 'twilio-ruby/rest/errors'
 require 'twilio-ruby/rest/utils'
 require 'twilio-ruby/rest/list_resource'
+require 'twilio-ruby/rest/next_gen_list_resource'
 require 'twilio-ruby/rest/instance_resource'
 require 'twilio-ruby/rest/sandbox'
 require 'twilio-ruby/rest/accounts'
@@ -34,6 +37,18 @@ require 'twilio-ruby/rest/sip/credential_lists'
 require 'twilio-ruby/rest/sip/credential_lists/credentials'
 require 'twilio-ruby/rest/sip/ip_access_control_lists'
 require 'twilio-ruby/rest/sip/ip_access_control_lists/ip_addresses'
+require 'twilio-ruby/rest/task_router/activities'
+require 'twilio-ruby/rest/task_router/events'
+require 'twilio-ruby/rest/task_router/reservations'
+require 'twilio-ruby/rest/task_router/task_queues'
+require 'twilio-ruby/rest/task_router/task_queues_statistics'
+require 'twilio-ruby/rest/task_router/tasks'
+require 'twilio-ruby/rest/task_router/workers'
+require 'twilio-ruby/rest/task_router/workers_statistics'
+require 'twilio-ruby/rest/task_router/workflow_statistics'
+require 'twilio-ruby/rest/task_router/workflows'
+require 'twilio-ruby/rest/task_router/workspaces'
+require 'twilio-ruby/rest/task_router/workspace_statistics'
 require 'twilio-ruby/rest/media'
 require 'twilio-ruby/rest/messages'
 require 'twilio-ruby/rest/applications'

data/spec/rest/client_spec.rb

@@ -181,4 +181,78 @@ describe Twilio::REST::Client do
       expect(client.send(method)).to eq(client.account.send(method))
     end
   end
+
+  it 'should throw an argument error if the workspace_sid is not set' do
+    expect { Twilio::REST::TaskRouterClient.new 'someSid', 'someToken' }.to raise_error(ArgumentError)
+  end
+
+  it 'should have its host set to taskrouter.twilio.com' do
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    connection = client.instance_variable_get('@connection')
+    expect(connection.address).to eq('taskrouter.twilio.com')
+  end
+
+  it 'should have task queue statistics resource' do
+    FakeWeb.register_uri(:get, %r/taskrouter\.twilio\.com/, body: '{}')
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:task_queue_statistics)
+    expect(client.task_queue_statistics('someSid').instance_variable_get('@path')).to eq('/v1/Workspaces/someSid/TaskQueues/someSid/Statistics')
+  end
+
+  it 'should have task queues statistics resource' do
+    FakeWeb.register_uri(:get, %r/taskrouter\.twilio\.com/, body: '{"meta": {"key": "task_queues_statistics"}, "task_queues_statistics": [{"task_queue_sid": "WQ123"}]}')
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:task_queues_statistics)
+    expect(client.task_queues_statistics[0].task_queue_sid).to eq('WQ123')
+  end
+
+  it 'should have worker statistics resource' do
+    FakeWeb.register_uri(:get, %r/taskrouter\.twilio\.com/, body: '{}')
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:worker_statistics)
+    expect(client.worker_statistics('someSid').instance_variable_get('@path')).to eq('/v1/Workspaces/someSid/Workers/someSid/Statistics')
+  end
+
+  it 'should have workers statistics resource' do
+    FakeWeb.register_uri(:get, %r/taskrouter\.twilio\.com/, body: '{}')
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:workers_statistics)
+    expect(client.workers_statistics.instance_variable_get('@path')).to eq('/v1/Workspaces/someSid/Workers/Statistics')
+  end
+
+  it 'should have workflow statistics resource' do
+    FakeWeb.register_uri(:get, %r/taskrouter\.twilio\.com/, body: '{}')
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:workflow_statistics)
+    expect(client.workflow_statistics('someSid').instance_variable_get('@path')).to eq('/v1/Workspaces/someSid/Workflows/someSid/Statistics')
+  end
+
+  it 'should have workspace statistics resource' do
+    FakeWeb.register_uri(:get, %r/taskrouter\.twilio\.com/, body: '{}')
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:workspace_statistics)
+    expect(client.workspace_statistics.instance_variable_get('@path')).to eq('/v1/Workspaces/someSid/Statistics')
+  end
+
+  it 'should set up a workspaces resource object' do
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:workspaces)
+    expect(client.workspaces.instance_variable_get('@path')).to eq('/v1/Workspaces')
+  end
+
+  it 'should set up a workspace resource object' do
+    client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+    expect(client).to respond_to(:workspace)
+    expect(client.workspace.instance_variable_get('@path')).to eq('/v1/Workspaces/someSid')
+  end
+
+  [
+      :activities, :tasks, :task_queues, :workers, :workflows
+  ].each do |method|
+    it "should delegate the client method #{method} to the workspace object" do
+      client = Twilio::REST::TaskRouterClient.new('someSid', 'someToken', 'someSid')
+      expect(client).to respond_to(method)
+      expect(client.send(method)).to eq(client.workspace.send(method))
+    end
+  end
 end

data/spec/rest/task_router/reservation_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Twilio::REST::TaskRouter::Reservations do
+  it 'creates a reservation object' do
+    task = Twilio::REST::TaskRouter::Task.new('someUri', 'someClient')
+    expect(task).to respond_to(:reservations)
+    expect(task.reservations.instance_variable_get('@path')).to eq('someUri/Reservations')
+  end
+end

data/spec/rest/task_router/task_queue_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Twilio::REST::TaskRouter::TaskQueues do
+  it 'creates a task queue object' do
+    workspace = Twilio::REST::TaskRouter::Workspace.new('someUri', 'someClient')
+    expect(workspace).to respond_to(:task_queues)
+    expect(workspace.task_queues.instance_variable_get('@path')).to eq('someUri/TaskQueues')
+  end
+end

data/spec/task_router_spec.rb

@@ -0,0 +1,114 @@
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twilio-ruby
 version: !ruby/object:Gem::Version
-  version: 3.15.0
+  version: 3.15.1
 platform: ruby
 authors:
 - Andrew Benton
@@ -153,6 +153,7 @@ files:
 - lib/twilio-ruby/rest/list_resource.rb
 - lib/twilio-ruby/rest/media.rb
 - lib/twilio-ruby/rest/messages.rb
+- lib/twilio-ruby/rest/next_gen_list_resource.rb
 - lib/twilio-ruby/rest/notifications.rb
 - lib/twilio-ruby/rest/outgoing_caller_ids.rb
 - lib/twilio-ruby/rest/queues.rb
@@ -170,12 +171,26 @@ files:
 - lib/twilio-ruby/rest/sms.rb
 - lib/twilio-ruby/rest/sms/messages.rb
 - lib/twilio-ruby/rest/sms/short_codes.rb
+- lib/twilio-ruby/rest/task_router/activities.rb
+- lib/twilio-ruby/rest/task_router/events.rb
+- lib/twilio-ruby/rest/task_router/reservations.rb
+- lib/twilio-ruby/rest/task_router/task_queues.rb
+- lib/twilio-ruby/rest/task_router/task_queues_statistics.rb
+- lib/twilio-ruby/rest/task_router/tasks.rb
+- lib/twilio-ruby/rest/task_router/workers.rb
+- lib/twilio-ruby/rest/task_router/workers_statistics.rb
+- lib/twilio-ruby/rest/task_router/workflow_statistics.rb
+- lib/twilio-ruby/rest/task_router/workflows.rb
+- lib/twilio-ruby/rest/task_router/workspace_statistics.rb
+- lib/twilio-ruby/rest/task_router/workspaces.rb
 - lib/twilio-ruby/rest/tokens.rb
 - lib/twilio-ruby/rest/transcriptions.rb
 - lib/twilio-ruby/rest/usage.rb
 - lib/twilio-ruby/rest/usage/records.rb
 - lib/twilio-ruby/rest/usage/triggers.rb
 - lib/twilio-ruby/rest/utils.rb
+- lib/twilio-ruby/task_router.rb
+- lib/twilio-ruby/task_router/capability.rb
 - lib/twilio-ruby/twiml/response.rb
 - lib/twilio-ruby/util.rb
 - lib/twilio-ruby/util/capability.rb
@@ -197,10 +212,13 @@ files:
 - spec/rest/recording_spec.rb
 - spec/rest/sms/message_spec.rb
 - spec/rest/sms/messages_spec.rb
+- spec/rest/task_router/reservation_spec.rb
+- spec/rest/task_router/task_queue_spec.rb
 - spec/rest/token_spec.rb
 - spec/rest/utils_spec.rb
 - spec/spec_helper.rb
 - spec/support/fakeweb.rb
+- spec/task_router_spec.rb
 - spec/twilio_spec.rb
 - spec/util/capability_spec.rb
 - spec/util/configuration_spec.rb
@@ -254,10 +272,13 @@ test_files:
 - spec/rest/recording_spec.rb
 - spec/rest/sms/message_spec.rb
 - spec/rest/sms/messages_spec.rb
+- spec/rest/task_router/reservation_spec.rb
+- spec/rest/task_router/task_queue_spec.rb
 - spec/rest/token_spec.rb
 - spec/rest/utils_spec.rb
 - spec/spec_helper.rb
 - spec/support/fakeweb.rb
+- spec/task_router_spec.rb
 - spec/twilio_spec.rb
 - spec/util/capability_spec.rb
 - spec/util/configuration_spec.rb