twilio-ruby 4.6.1 → 6.9.0

data/docs/usage/validation.rst

@@ -1,107 +0,0 @@
-.. module:: twilio.util
-
-===========================
-Validate Incoming Requests
-===========================
-
-Twilio requires that your TwiML-serving web server be open to the public. This
-is necessary so that Twilio can retrieve TwiML from urls and POST data back to
-your server.
-
-However, there may be people out there trying to spoof the Twilio service.
-Luckily, there's an easy way to validate that incoming requests are from Twilio
-and Twilio alone.
-
-An in-depth guide to our security features can be `found in our online
-documentation <http://www.twilio.com/docs/security>`_.
-
-Before you can validate requests, you'll need four pieces of information:
-
-* your Twilio Auth Token (found in your `Dashboard
-  <https://www.twilio.com/user/account>`_)
-* the POST data for the request
-* the requested URL
-* the X-Twilio-Signature header value
-
-Obtaining the last three pieces of information depends on the framework you are
-using to process requests. The below example assumes that you have the POST
-data as a dictionary and the url and X-Twilio-Signature as strings.
-
-The below example will print out a confirmation message if the request is
-actually from Twilio.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    auth_token = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
-
-    @validator = Twilio::Util::RequestValidator.new auth_token
-
-    # the callback URL you provided to Twilio
-    url = "http://www.example.com/my/callback/url.xml"
-
-    # the POST variables attached to the request (eg "From", "To")
-    post_vars = {}
-
-    # X-Twilio-Signature header value
-    signature = "HpS7PBa1Agvt4OtO+wZp75IuQa0=" # will look something like that
-
-    if @validator.validate(url, post_vars, signature)
-      puts "Confirmed to have come from Twilio."
-    else
-      puts "NOT VALID.  It might have been spoofed!"
-    end
-
-Trailing Slashes
-==================
-
-If your URL uses an "index" page, such as index.php or index.html to handle
-the request, such as: https://mycompany.com/twilio where the real page
-is served from https://mycompany.com/twilio/index.php, then Apache or
-PHP may rewrite that URL a little bit so it's got a trailing slash, such as
-https://mycompany.com/twilio/ for example.
-
-Using the code above, or similar code in another language, you could
-end up with an incorrect hash because Twilio built the hash using
-https://mycompany.com/twilio and you may have built the hash using
-https://mycompany.com/twilio/. More information can be found in our
-documentation on validating requests.
-
-Rack Middleware
-===============
-
-If you are serving up your site using a Rack based framework, such as Sinatra or
-Rails, you can use the Rack middleware that is included in the gem to protect
-from spoofing attempts.
-
-To use the middleware, you need to set it up with your Twilio Auth Token and a
-set of paths to watch. For example, here is how you would use the middleware in
-a Sinatra application:
-
-.. code-block:: ruby
-
-    require 'sinatra'
-    require 'twilio-ruby'
-
-    auth_token = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
-
-    use Rack::TwilioWebhookAuthentication, auth_token, /\/messages/
-
-    post '/messages' do
-      # response with TwiML
-    end
-
-Now, any POST request to /messages in your application that doesn't validate as
-a Twilio request, will automatically respond with a 403 status code and your
-action will not be hit.
-
-If you use subaccounts and need to validate with different auth tokens, you can pass a block to the middleware instead of an auth token. The block will be passed the Account Sid making the call.
-
-.. code-block:: ruby
-
-    use Rack::TwilioWebhookAuthentication, nil, /\/messages/ do |account_sid|
-      # lookup auth_token from account_sid
-    end
-
-Ensure you pass `nil` for the auth_token when passing a block, otherwise the block will not be called.

data/examples/taskrouter.examples.rb

@@ -1,86 +0,0 @@
-require 'rubygems'
-require 'twilio-ruby'
-
-# taskrouter examples version 1
-account_sid = 'YourAccountSid'
-auth_token  = 'YourAuthToken'
-workspace_sid = 'YourWorkspaceSid'
-
-# set up a client
-client = Twilio::REST::TaskRouterClient.new account_sid, auth_token, workspace_sid
-puts client.workspace.sid + ' with ' + client.workspace.friendly_name
-
-client.workspace.update(friendly_name: 'MyWorkspace2')
-
-# fetch the list of workers and their status
-client.workspace.workers.list.each do |worker|
-  puts worker.friendly_name + ' is available ' + worker.available.to_s
-end
-
-# fetch the list of workers and their status
-client.workspace.workers.list(activity_name: 'Offline').each do |worker|
-  puts worker.friendly_name + ' is available ' + worker.available.to_s
-end
-
-# create a task
-workflow_sid = 'YourWorkflowSid'
-task = client.workspace.tasks.create(attributes: '{"foo":"bar"}', workflow_sid: workflow_sid)
-
-# list all the tasks created
-client.workspace.tasks.list.each do |task|
-  attributes = JSON.parse(task.attributes)
-  puts attributes['foo'] + ' with age ' + task.age.to_s
-  task.reservations.list.each do |reservation|
-    puts reservation.sid
-  end
-end
-
-# fetching a list of tasks that are pending
-client.workspace.tasks.list(assignment_status: 'pending').each do |task|
-  puts 'pending task ' + task.sid
-end
-
-# delete all tasks
-client.workspace.tasks.list.each do |task|
-  puts 'deleting task ' + task.sid
-  task.delete
-end
-
-# get all the statistics for a workspace
-workspace_stats = client.workspace.statistics(minutes: '240')
-cumulative = workspace_stats.cumulative
-puts 'Avg Task Acceptance Time: ' + cumulative['avg_task_acceptance_time'].to_s \
-      + ' with ' + cumulative['tasks_created'].to_s + ' tasks created'
-
-# get events for a workspace
-events = client.workspace.events.list(minutes: '15')
-events.each do |event|
-  puts event.event_type + ' at ' + event.event_date
-end
-
-# build a workflow
-support_queue_sid = 'YourSupportQueueSid'
-marketing_queue_sid = 'YourMarketingQueueSid'
-default_queue_sid = 'YourDefaultQueue'
-
-support_targets = [Twilio::TaskRouter::WorkflowRuleTarget.new support_queue_sid]
-support_rule = Twilio::TaskRouter::WorkflowRule.new 'type == "support"', support_targets
-
-marketing_targets = [Twilio::TaskRouter::WorkflowRuleTarget.new marketing_queue_sid]
-marketing_rule = Twilio::TaskRouter::WorkflowRule.new 'type == "marketing"', marketing_targets
-
-rules = [support_rule, marketing_rule]
-default_target = Twilio::TaskRouter::WorkflowRuleTarget.new default_queue_sid
-
-config = Twilio::TaskRouter::WorkflowConfiguration.new rules, default_target
-puts config.to_json
-
-workflowCreated = client.workspace.workflows.create(configuration: config.to_json, friendly_name: 'MyWorkflow2', assignment_callback_url: 'http://example.com')
-workflowFetched = client.workspace.workflows.get(workflowCreated.sid)
-
-config_string = workflowFetched.configuration
-config_obj = Twilio::TaskRouter::WorkflowConfiguration.parse_json(config_string)
-
-puts config_string
-puts config_obj.rules[0].expression
-puts config_obj.default_target.queue

data/lib/twilio-ruby/rest/addresses/dependent_phone_numbers.rb

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class DependentPhoneNumbers < ListResource; end
-    class DependentPhoneNumber < InstanceResource; end
-  end
-end

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

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Addresses < ListResource; end
-
-    class Address < InstanceResource
-      def initialize(path, client, params={})
-        super path, client, params
-        resource :dependent_phone_numbers
-      end
-    end
-  end
-end

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

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class Applications < ListResource; end
-    class Application < InstanceResource; end
-  end
-end

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

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class AuthorizedConnectApps < ListResource; end
-    class AuthorizedConnectApp < InstanceResource; end
-  end
-end

data/lib/twilio-ruby/rest/available_phone_numbers/country.rb

@@ -1,10 +0,0 @@
-module Twilio
-  module REST
-    class Country < InstanceResource
-      def initialize(path, client, params={})
-        super path, client, params
-        resource :local, :toll_free, :mobile
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/available_phone_numbers/local.rb

@@ -1,11 +0,0 @@
-module Twilio
-  module REST
-    class Local < ListResource
-      def initialize(path, client)
-        @path, @client = path, client
-        @instance_class = Twilio::REST::AvailablePhoneNumber
-        @list_key, @instance_id_key = 'available_phone_numbers', 'sid'
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/available_phone_numbers/mobile.rb

@@ -1,11 +0,0 @@
-module Twilio
-  module REST
-    class Mobile < ListResource
-      def initialize(path, client)
-        @path, @client = path, client
-        @instance_class = Twilio::REST::AvailablePhoneNumber
-        @list_key, @instance_id_key = 'available_phone_numbers', 'sid'
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/available_phone_numbers/toll_free.rb

@@ -1,11 +0,0 @@
-module Twilio
-  module REST
-    class TollFree < ListResource
-      def initialize(path, client)
-        @path, @client = path, client
-        @instance_class = Twilio::REST::AvailablePhoneNumber
-        @list_key, @instance_id_key = 'available_phone_numbers', 'sid'
-      end
-    end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    class AvailablePhoneNumbers < ListResource
-      def initialize(path, client)
-        @path, @client = path, client
-        @instance_class = Twilio::REST::Country
-        @list_key, @instance_id_key = 'countries', 'country_code'
-      end
-    end
-
-    class AvailablePhoneNumber < InstanceResource; end
-  end
-end

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

@@ -1,130 +0,0 @@
-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})"
-      }
-
-      ##
-      # Override the default host for a REST Client (api.twilio.com)
-      def self.host(host=nil)
-        return @host unless host
-        @host = host
-      end
-
-      attr_reader :account_sid, :last_request, :last_response
-
-      def initialize(*args)
-        options = args.last.is_a?(Hash) ? args.pop : {}
-        options[:host] ||= self.class.host
-        @config = Twilio::Util::ClientConfig.new 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
-
-      ##
-      # 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?
-          # build the full path unless already given
-          path = build_full_path(path, params, method) unless args[1]
-          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
-
-      protected
-
-      ##
-      # Builds up full request path
-      # Needs implementation in child classes
-      def build_full_path(path, params, method)
-        raise NotImplementedError
-      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
-          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
-        elsif response.kind_of? Net::HTTPBadRequest
-          object = { message: 'Bad request', code: 400 }
-        end
-
-        if response.kind_of? Net::HTTPClientError
-          raise Twilio::REST::RequestError.new object['message'], object['code']
-        end
-        object
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-module Twilio
-  module REST
-    class Feedback < ListResource;
-
-      ##
-      # Get this feedback object.
-      #
-      # Overridden because GETS to /Feedback
-      # returns an instance, not a list.
-      def get(params={}, full_path=false)
-        raise "Can't fetch feedback without a REST Client" unless @client
-        response = @client.get @path, params, full_path
-        path = full_path ? @path.split('.')[0] : @path
-        @instance_class.new path, @client, response
-      end
-
-      ##
-      # Creates a new Feedback object.
-      def create(params={})
-        raise "Can't create feedback without a REST Client" unless @client
-        response = @client.post @path, params
-        @instance_class.new @path, @client, response
-      end
-    end
-
-    class FeedbackInstance < InstanceResource; end
-  end
-end

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

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    class FeedbackSummary < ListResource
-      def initialize(path, client)
-        @path, @client = path, client
-        @instance_class = Twilio::REST::FeedbackSummaryInstance
-        @list_key, @instance_id_key = 'feedback_summary', 'sid'
-      end
-    end
-
-    class FeedbackSummaryInstance < InstanceResource; end
-  end
-end

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

@@ -1,33 +0,0 @@
-module Twilio
-  module REST
-    class Calls < ListResource
-      def initialize(path, client)
-        super
-        resource :feedback_summary
-      end
-
-      def make(from, to, url)
-        create from: from, to: to, url: url
-      end
-    end
-
-    class Call < InstanceResource
-      def initialize(path, client, params={})
-        super path, client, params
-        resource :recordings, :notifications, :feedback
-      end
-
-      def redirect_to(url)
-        update url: url
-      end
-
-      def cancel
-        update status: 'canceled'
-      end
-
-      def hangup
-        update status: 'completed'
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/conferences/participants.rb

@@ -1,23 +0,0 @@
-module Twilio
-  module REST
-    class Participants < ListResource
-      def initialize(path, client)
-        super
-        # hard-code the json key since participants don't have sids
-        @instance_id_key = 'call_sid'
-      end
-    end
-
-    class Participant < InstanceResource
-      def mute
-        update muted: 'true'
-      end
-
-      def unmute
-        update muted: 'false'
-      end
-
-      alias :kick :delete
-    end
-  end
-end

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

@@ -1,12 +0,0 @@
-module Twilio
-  module REST
-    class Conferences < ListResource; end
-
-    class Conference < InstanceResource
-      def initialize(path, client, params={})
-        super path, client, params
-        resource :participants
-      end
-    end
-  end
-end

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

@@ -1,6 +0,0 @@
-module Twilio
-  module REST
-    class ConnectApps < ListResource; end
-    class ConnectApp < InstanceResource; end
-  end
-end

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

@@ -1,14 +0,0 @@
-module Twilio
-  module REST
-    class ServerError < StandardError; end
-
-    class RequestError < StandardError
-      attr_reader :code
-
-      def initialize(message, code=nil);
-        super message
-        @code = code
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/incoming_phone_numbers/local.rb

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    module NumberType
-      class Local < ListResource
-        def initialize(path, client)
-          @path, @client = path, client
-          @instance_class = Twilio::REST::IncomingPhoneNumber
-          @list_key, @instance_id_key = 'incoming_phone_numbers', 'sid'
-        end
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/incoming_phone_numbers/mobile.rb

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    module NumberType
-      class Mobile < ListResource
-        def initialize(path, client)
-          @path, @client = path, client
-          @instance_class = Twilio::REST::IncomingPhoneNumber
-          @list_key, @instance_id_key = 'incoming_phone_numbers', 'sid'
-        end
-      end
-    end
-  end
-end

data/lib/twilio-ruby/rest/incoming_phone_numbers/toll_free.rb

@@ -1,13 +0,0 @@
-module Twilio
-  module REST
-    module NumberType
-      class TollFree < ListResource
-        def initialize(path, client)
-          @path, @client = path, client
-          @instance_class = Twilio::REST::IncomingPhoneNumber
-          @list_key, @instance_id_key = 'incoming_phone_numbers', 'sid'
-        end
-      end
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-module Twilio
-  module REST
-    class IncomingPhoneNumbers < ListResource
-      def initialize(path, client)
-        super
-        @submodule = :NumberType
-        resource :mobile, :local, :toll_free
-      end
-
-      def buy(phone_number)
-        create phone_number: phone_number
-      end
-    end
-
-    class IncomingPhoneNumber < InstanceResource; end
-  end
-end