twilio-ruby 4.13.0 → 5.0.0.alpha1

data/docs/usage/token-generation.rst

@@ -1,115 +0,0 @@
-.. module:: twilio.util
-
-===========================
-Generate Capability Tokens
-===========================
-
-`Twilio Client <http://www.twilio.com/api/client>`_ allows you to make and
-receive connections in the browser.
-You can place a call to a phone on the PSTN network,
-all without leaving your browser. See the `Twilio Client Quickstart
-<http:/www.twilio.com/docs/quickstart/client>`_ to get up and running with
-Twilio Client.
-
-Capability tokens are used by `Twilio Client
-<http://www.twilio.com/api/client>`_ to provide connection
-security and authorization. The `Capability Token documentation
-<https://www.twilio.com/docs/client/capability-tokens>`_ explains in depth the purpose and
-features of these tokens.
-
-:class:`Twilio::Util::Capability` is responsible for the creation of these
-capability tokens. You'll need your Twilio AccountSid and AuthToken.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # Find these values at twilio.com/user/account
-    account_sid = "AC123123"
-    auth_token = "secret"
-
-    @capability = Twilio::Util::Capability.new account_sid, auth_token
-
-You can also configure capability tokens using the top level configure method,
-like so:
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio.configure do |config|
-      config.account_sid = "ACXXXXXXXXXXXXXXXXX"
-      config.auth_token = "YYYYYYYYYYYYYYYYYY"
-    end
-
-    @capability = Twilio::Util::Capability.new
-
-
-
-Allow Incoming Connections
-==============================
-
-Before a device running `Twilio Client <http://www.twilio.com/api/client>`_
-can recieve incoming connections, the instance must first register a name
-(such as "Alice" or "Bob").
-The :meth:`allow_client_incoming` method adds the client name to the
-capability token.
-
-.. code-block:: ruby
-
-    @capability.allow_client_incoming("Alice")
-
-
-Allow Outgoing Connections
-==============================
-
-To make an outgoing connection from a
-`Twilio Client <http://www.twilio.com/api/client>`_ device,
-you'll need to choose a
-`Twilio Application <http://www.twilio.com/docs/api/rest/applications>`_
-to handle TwiML URLs. A Twilio Application is a collection of URLs responsible
-for outputting valid TwiML to control phone calls and messages.
-
-.. code-block:: ruby
-
-    # Twilio Application Sid
-    application_sid = "APabe7650f654fc34655fc81ae71caa3ff"
-    @capability.allow_client_outgoing(application_sid)
-    
-Add Parameters to an Outgoing Scope
-===================================
-
-You can send parameters to your Twilio Application's :attr:`VoiceUrl` by passing
-a hash to :attr:`#allow_client_outgoing`. Here we pass along a hypothetical user
-id.
-
-.. code-block:: ruby
-
-    application_sid = "APabe7650f654fc34655fc81ae71caa3ff"
-    params = {'user_id' => @user.id}
-
-    # Allow outgoing calls to an application and pass the user id to your server.
-    @capability.allow_client_outgoing(application_sid, params)
-
-The :attr:`user_id` parameter and its value will be sent to your Application's
-:attr:`VoiceUrl` along with the other parameters that Twilio usually sends, like
-:attr:`From`, :attr:`To` and :attr:`CallSid`.
-
-
-Generate a Token
-==================
-
-.. code-block:: ruby
-
-    @token = @capability.generate()
-
-By default, this token will expire in one hour. If you'd like to change the
-token expiration, :meth:`generate` takes an optional :attr:`ttl` argument.
-
-.. code-block:: ruby
-
-    @token = @capability.generate(ttl=600)
-
-This token will now expire in 10 minutes. If you haven't guessed already,
-:attr:`ttl` is expressed in seconds.
-

data/docs/usage/transcriptions.rst

@@ -1,32 +0,0 @@
-.. module:: twilio.rest.resources
-
-================
-Transcriptions
-================
-
-Transcriptions are generated from recordings via the
-`TwiML <Record> verb <http://www.twilio.com/docs/api/twiml/record>`_.
-Using the API, you can only read your transcription records.
-
-For more information, see the `Transcriptions REST Resource
-<http://www.twilio.com/docs/api/rest/transcription>`_ documentation.
-
-
-Listing Your Transcriptions
-----------------------------
-
-The following code will print out the length of each :class:`Transcription`.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    # To find these visit https://www.twilio.com/user/account
-    account_sid = "ACXXXXXXXXXXXXXXXXX"
-    auth_token = "YYYYYYYYYYYYYYYYYY"
-
-    @client = Twilio::REST::Client.new account_sid, auth_token
-    @client.transcriptions.list().each do |transcription|
-      puts transcription.duration
-    end
-

data/docs/usage/twiml.rst

@@ -1,69 +0,0 @@
-.. _usage-twiml:
-
-.. module:: twilio.twiml
-
-==============
-TwiML Creation
-==============
-
-TwiML creation begins with the :class:`Response` verb.
-Each successive verb is created by calling various methods on the response,
-such as :meth:`say` or :meth:`play`.
-These methods return the verbs they create to ease creation of nested TwiML.
-To finish, call the :meth:`toxml` method on the :class:`Response`,
-which returns raw TwiML.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio::TwiML::Response.new do |r|
-      r.Say "Hello"
-    end.text
-
-.. code-block:: xml
-
-   <?xml version="1.0" encoding="utf-8"?>
-   <Response><Say>Hello</Say><Response>
-
-The verb methods (outlined in the :doc:`complete reference </api/twiml>`)
-take the body (only text) of the verb as the first argument.
-All attributes are keyword arguments.
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio::TwiML::Response.new do |r|
-      r.Play "https://api.twilio.com/cowbell.mp3", loop: 5
-    end.text
-
-.. code-block:: xml
-
-    <?xml version="1.0" encoding="utf-8"?>
-    <Response>
-      <Play loop="3">https://api.twilio.com/cowbell.mp3</Play>
-    <Response>
-
-Any example of nesting nouns in verbs
-
-.. code-block:: ruby
-
-    require 'twilio-ruby'
-
-    Twilio::TwiML::Response.new do |r|
-      r.Say "hello"
-      r.Gather finishOnKey: => 4 do |g|
-        g.Say "world"
-      end
-    end.text
-
-which returns the following
-
-.. code-block:: xml
-
-    <?xml version="1.0" encoding="utf-8"?>
-    <Response>
-      <Say>Hello</Say>
-      <Gather finishOnKey="4"><Say>World</Say></Gather>
-    </Response>

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/issue_template.md

@@ -1,25 +0,0 @@
-*Note: These issues are for bugs and feature requests for the helper libraries. If you need help or support, please email help@twilio.com and one of our experts will assist you!*
-
-
-**Version:**
-**API Subdomain (api/taskrouter/ip_messaging):**
-
-### Code Snippet
-```ruby
-# paste code here
-```
-
-### Exception / Log
-```
-<place exception / log here>
-```
-
-### Steps to Reproduce
-1.
-2.
-3.
-
-
-### Feature Request
-_If this is a feature request, make sure you search Issues for an existing request before creating a new one!_
-

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