plivo 0.3.19 → 4.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69f17b3110741fa96e01482d33428105adf80494
-  data.tar.gz: 523a1d10dcd6460ead4d1211f6c068a3a3e6e53c
+  metadata.gz: 4b3769ca665c441fa19c2ac4aac8844876e6625a
+  data.tar.gz: 5478cb00e8c5c79760447aabc913a7e64f9b9596
 SHA512:
-  metadata.gz: c97730771de4bb3abdfd55d8c5e3705455ae059d57e4f976a4a35c86abdb02eb401b061c45d1bd045ff87d21bbaa16b6956326cafc635e44d19c8e6e0e8cdf39
-  data.tar.gz: 063f82c22953e7fa294a1b9bec40b7eeb39dc13e51b3f1eaaeb5b492d51b88abc153d166ac8bad59b910397e0105c45261c1e07a7b0abb9c7d06c7e34b1984a5
+  metadata.gz: 56dab2850afb6b10de0bb5ee58270cbb5495db06b46bff6eade3ea739798d19e83843fe0b2a19736199ca4a9fbf1333180a416d1943f227f3810c57d11652c8c
+  data.tar.gz: 61496cb4d40060e34e635cbacfa1bb7e95a6fc2a5d4ec01b36c9187fd21b3785970178bfff456ba8781140b4c68103d406033d74cb2360092533b8718c91c354

data/.gitignore

@@ -0,0 +1,14 @@
+.idea/
+.DS_STORE
+.bundle/
+.yardoc
+Gemfile.lock
+_yardoc/
+coverage/
+pkg/
+doc/
+spec/reports/
+tmp/
+bin/
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - ruby-head
+  - 2.4.0
+  - 2.3.0
+  - 2.2.0
+  - 2.1
+  - 2.0.0
+before_install: gem install bundler -v 1.14.6

data/AUTHORS.md

@@ -0,0 +1,4 @@
+# Authors
+- [Sreyantha Chary](https://sreyanth.com?ref=github/plivo-python) ([@sreyanth](https://github.com/sreyanth))
+- Kritarth ([@kritarth3010](https://github.com/kritarth3010))
+- Abhishek ([@abhishek-plivo](https://github.com/abhishek-plivo))

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+## [v0.3.19](https://github.com/plivo/plivo-ruby/tree/v0.3.19) (2015-11-24)
+- Add `modify_number` function
+
+## [0.3.17](https://github.com/plivo/plivo-ruby/tree/v0.3.17) (2015-07-21)
+- Add support for `digitsMatchBLeg` in Dial XML
+- `stop_speak_member` function added
+
+## Other changes
+- 2013-10-23 Added `stop_speak()`
+- 2013-09-25 Added `relayDTMF` to `<Conference>` and `async` to `<DTMF>`
+- 2013-08-17 Fix unicode characters only for speak element.
+- 2013-08-12 Fix unicode characters only for speak APIs.
+- 2013-07-26 Added `XPlivoSignature` header validation.
+- 2013-07-21 Added outgoing carrier and carrier routing apis.
+- 2013-07-20 Added `recordWhenAlone` to `<Conference>`.
+- 2013-07-14 Unicode character support in XML and API.
+- 2013-03-15 Added `min_silence` to `<Wait>`.
+- 2013-02-23 Pricing API added.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (C) 2017, Plivo Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,48 +1,129 @@
-# Plivo Ruby Library
+# plivo-ruby
+The Plivo Ruby SDK makes it simpler to integrate communications into your Ruby applications using the Plivo REST API. Using the SDK, you will be able to make voice calls, send SMS and generate Plivo XML to control your call flows.
 
-[![Gem Version](https://badge.fury.io/rb/plivo.png)](http://badge.fury.io/rb/plivo) 
-[![Dependency Status](https://gemnasium.com/plivo/plivo-ruby.png)](https://gemnasium.com/plivo/plivo-ruby)
+## Installation
+Add this line to your application's Gemfile:
 
-## Description
+```ruby
+gem 'plivo', '>= 4.0.0.beta.1'
+```
+
+And then execute:
+
+    $ bundle
 
-The Plivo Ruby library simplifies the process of making REST calls and generating RESTXML.
+Or install it yourself as:
 
-See [Plivo Documentation](http://www.plivo.com/docs/) for more information.
+    $ gem install plivo --pre
 
+If you have the `0.3.19` version (a.k.a legacy) already installed, you may have to first uninstall it before installing the new version.
 
-## GEM Installation
+## Getting started
 
-    $ sudo gem install plivo
+### Authentication
+To make the API requests, you need create a `RestClient` and provide it with authentication credentials (which can be found at [https://manage.plivo.com/dashboard/](https://manage.plivo.com/dashboard/)).
 
+We recommend that you store your credentials in the `PLIVO_AUTH_ID` and the `PLIVO_AUTH_TOKEN` environment variables, so as to avoid the possibility of accidentally committing them to source control. If you do this, you can initialise the client with no arguments and it will automatically fetch them from the environment variables:
 
-## Manual Installation
+```ruby
+client = RestClient.new;
+```
+
+Alternatively, you can specifiy the authentication credentials while initializing the `RestClient`.
 
-To use the rake command to build the gem and
+```ruby
+client = RestClient.new('your_auth_id', 'your_auth_token');
+```
 
-**Download the source and run:**
-    $ sudo gem install /path/to/plivo/gem
+### The basics
+The SDK uses consistent interfaces to create, retrieve, update, delete and list resources. The pattern followed is as follows:
 
-to finish the installation
+```ruby
+client.resources.create(params); # Create
+client.resources.get(resource_identifier); # Get
+client.resources.update(resource_identifier, params); # Update
+client.resources.delete(resource_identifier); # Delete
+client.resources.list; # List all resources, max 20 at a time
+```
 
-### Requirements
+You can also use the `resource` directly to update and delete it. For example,
 
+```ruby
+resource = client.resources.get(resource_identifier);
+resource.update(params); # update the resource
+resource.delete(); # Delete the resource
 ```
-gem "rest-client", "~> 1.6.7"
-gem "json", "~> 1.6.6"
-gem "htmlentities", "~> 4.3.1"
+
+Also, using `client.resources.list` would list the first 20 resources by default (which is the first page, with `limit` as 20, and `offset` as 0). To get more, you will have to use `limit` and `offset` to get the second page of resources.
+
+To list all resources, you can simply use the following pattern that will handle the pagination for you automatically, so you won't have to worry about passing the right `limit` and `offset` values.
+
+```ruby
+client.resources.each do |resource|
+  puts resource.id
+end
 ```
 
-## Usage
+## Examples
+
+### Send a message
 
-To use the Plivo Ruby library, you will need to specify the AUTH_ID and AUTH_TOKEN, before you can make REST requests.
+```ruby
+require 'rubygems'
+require 'plivo'
 
-See [Plivo Documentation](http://www.plivo.com/docs/) for more information.
+include Plivo
 
-## Files
+client = RestClient.new
+message_created = client.messages.create(
+  'your_source_number',
+  %w[your_destination_number_1 your_destination_number_2],
+  'Hello, world!'
+)
+```
 
-**lib/plivo.rb:** include this library in your code
+### Make a call
 
-# License
+```ruby
+require 'rubygems'
+require 'plivo'
+
+include Plivo
+
+client = RestClient.new
+call_made = client.calls.create(
+  'your_source_number',
+  ['your_destination_number'],
+  'https://answer.url'
+)
+```
+
+### Generate Plivo XML
+
+```ruby
+require 'rubygems'
+require 'plivo'
+
+include Plivo::XML
+
+response = Response.new
+response.addSpeak('Hello, world!')
+puts response.to_xml # Prints the XML string
+
+xml_response = PlivoXML.new(response)
+puts xml_response.to_xml # Prints XML along with XML version & encoding details
+```
+This generates the following XML:
+
+```xml
+<?xml version="1.0" encoding="utf-8" ?>
+<Response>
+  <Speak>Hello, world!</Speak>
+</Response>
+```
 
+### More examples
+Refer to the [Ruby API Reference](https://api-reference.plivo.com/latest/ruby/introduction/overview) for more examples. Also refer to the [guide to setting up dev environment](https://developers.plivo.com/getting-started/setting-up-dev-environment/) on [Plivo Developers Portal](https://developers.plivo.com) to setup a Sinatra server & use it to test out your integration in under 5 minutes.
 
-The Plivo Ruby library is distributed under the MPL 1.1 License
+## Reporting issues
+Report any feedback or problems with this beta version by [opening an issue on Github](https://github.com/plivo/plivo-ruby/issues).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/lib/plivo.rb

@@ -1,815 +1,9 @@
-require 'rubygems'
-require 'restclient'
-require 'json'
-require 'rexml/document'
-require 'htmlentities'
-require 'openssl'
-require 'base64'
-
-module Plivo
-    class PlivoError < StandardError
-    end
-
-    class XPlivoSignature
-        attr_accessor :signature, :uri, :post_params, :auth_token
-
-        def initialize(signature, uri, post_params, auth_token)
-            @signature = signature
-            @uri = uri
-            @post_params = post_params
-            @auth_token = auth_token
-        end
-
-        def is_valid?
-            uri = @post_params.sort.reduce(@uri) {|_, (key, val)| _ += key + val}
-            return Base64.encode64(OpenSSL::HMAC.digest('sha1', @auth_token, uri)).chomp.eql? @signature
-        end
-
-    end
-
-    class RestAPI
-        attr_accessor :auth_id, :auth_token, :url, :version, :api, :headers, :rest
-
-        def initialize(auth_id, auth_token, url="https://api.plivo.com", version="v1")
-            @auth_id = auth_id
-            @auth_token = auth_token
-            @url = url.chomp('/')
-            @version = version
-            @api = @url + '/' + @version + '/Account/' + @auth_id
-            @headers = {"User-Agent" => "RubyPlivo"}
-            @rest = RestClient::Resource.new(@api, @auth_id, @auth_token)
-        end
-
-        def hash_to_params(myhash)
-            return myhash.map { |k, v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join("&")
-        end
-
-        def request(method, path, params=nil)
-            if method == "POST"
-                if not params
-                    params = {}
-                end
-                begin
-                    r = @rest[path].post params.to_json, :content_type => 'application/json'
-                rescue => e
-                    response = e
-                end
-                if not response
-                    code = r.code
-                    raw = r.to_str
-                    response = JSON.parse(raw)
-                else
-                    code = response.http_code
-                    response = JSON.parse(response.response.to_s)
-                end
-                return [code, response]
-            elsif method == "GET"
-                if params
-                    path = path + '?' + hash_to_params(params)
-                end
-
-                begin
-                    r = @rest[path].get
-                rescue => e
-                    response = e
-                end
-                if not response
-                    code = r.code
-                    raw = r.to_str
-                    response = JSON.parse(raw)
-                else
-                    code = response.http_code
-                    response = JSON.parse(response.response.to_s)
-                end
-                return [code, response]
-            elsif method == "DELETE"
-                if params
-                    path = path + '?' + hash_to_params(params)
-                end
-                begin
-                    r = @rest[path].delete
-                rescue => e
-                    response = e
-                end
-                if not response
-                    code = r.code
-                else
-                    code = response.http_code
-                    response = JSON.parse(response.response.to_s)
-                end
-                return [code, ""]
-            end
-            return [405, 'Method Not Supported']
-        end
-
-        ## Accounts ##
-        def get_account(params={})
-            return request('GET', "/", params)
-        end
-
-        def modify_account(params={})
-            return request('POST', "/", params)
-        end
-
-        def get_subaccounts(params={})
-            return request('GET', "/Subaccount/", params)
-        end
-
-        def create_subaccount(params={})
-            return request('POST', "/Subaccount/", params)
-        end
-
-        def get_subaccount(params={})
-            subauth_id = params.delete("subauth_id") || params.delete(:subauth_id)
-            return request('GET', "/Subaccount/#{subauth_id}/", params)
-        end
-
-        def modify_subaccount(params={})
-            subauth_id = params.delete("subauth_id") || params.delete(:subauth_id)
-            return request('POST', "/Subaccount/#{subauth_id}/", params)
-        end
-
-        def delete_subaccount(params={})
-            subauth_id = params.delete("subauth_id") || params.delete(:subauth_id)
-            return request('DELETE', "/Subaccount/#{subauth_id}/", params)
-        end
-
-        ## Applications ##
-        def get_applications(params={})
-            return request('GET', "/Application/", params)
-        end
-
-        def create_application(params={})
-            return request('POST', "/Application/", params)
-        end
-
-        def get_application(params={})
-            app_id = params.delete("app_id")
-            return request('GET', "/Application/#{app_id}/", params)
-        end
-
-        def modify_application(params={})
-            app_id = params.delete("app_id")
-            return request('POST', "/Application/#{app_id}/", params)
-        end
-
-        def delete_application(params={})
-            app_id = params.delete("app_id")
-            return request('DELETE', "/Application/#{app_id}/", params)
-        end
-
-        ## Numbers ##
-        def search_phone_number(params={})
-            return request('GET', "/PhoneNumber/", params)
-        end
-
-        def buy_phone_number(params={})
-            number = params.delete("number")
-            return request('POST', "/PhoneNumber/#{number}/", params)
-        end
-
-        def get_numbers(params={})
-            return request('GET', "/Number/", params)
-        end
-
-        def modify_number(params={})
-            number = params.delete("number")
-            return request('POST', "/Number/#{number}/", params)
-        end
-
-        def search_numbers(params={})
-            return request('GET', "/AvailableNumber/", params)
-        end
-
-        def get_number(params={})
-            number = params.delete("number")
-            return request('GET', "/Number/#{number}/", params)
-        end
-
-        def rent_number(params={})
-            number = params.delete("number")
-            return request('POST', "/AvailableNumber/#{number}/", params)
-        end
-
-        def unrent_number(params={})
-            number = params.delete("number")
-            return request('DELETE', "/Number/#{number}/", params)
-        end
-
-        def link_application_number(params={})
-            number = params.delete("number")
-            return request('POST', "/Number/#{number}/", params)
-        end
-
-        def unlink_application_number(params={})
-            number = params.delete("number")
-            params = {"app_id" => ""}
-            return request('POST', "/Number/#{number}/", params)
-        end
-
-        def get_number_group(params={})
-            return request('GET', "/AvailableNumberGroup/", params)
-        end
-
-        def get_number_group_details(params={})
-            group_id = params.delete('group_id')
-            return request('GET', "/AvailableNumberGroup/#{group_id}/", params)
-        end
-
-        def rent_from_number_group(params={})
-            group_id = params.delete('group_id')
-            return request('POST', "/AvailableNumberGroup/#{group_id}/", params)
-        end
-
-        ## Calls ##
-        def get_cdrs(params={})
-            return request('GET', "/Call/", params)
-        end
-
-        def get_cdr(params={})
-            record_id = params.delete('record_id')
-            return request('GET', "/Call/#{record_id}/", params)
-        end
-
-        def get_live_calls(params={})
-            params["status"] = "live"
-            return request('GET', "/Call/", params)
-        end
-
-        def get_live_call(params={})
-            call_uuid = params.delete('call_uuid')
-            params["status"] = "live"
-            return request('GET', "/Call/#{call_uuid}/", params)
-        end
-
-        def make_call(params={})
-            return request('POST', "/Call/", params)
-        end
-
-        def hangup_all_calls(params={})
-            return request('DELETE', "/Call/", params)
-        end
-
-        def transfer_call(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('POST', "/Call/#{call_uuid}/", params)
-        end
-
-        def hangup_call(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('DELETE', "/Call/#{call_uuid}/", params)
-        end
-
-        def record(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('POST', "/Call/#{call_uuid}/Record/", params)
-        end
-
-        def stop_record(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('DELETE', "/Call/#{call_uuid}/Record/", params)
-        end
-
-        def play(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('POST', "/Call/#{call_uuid}/Play/", params)
-        end
-
-        def stop_play(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('DELETE', "/Call/#{call_uuid}/Play/", params)
-        end
-
-        def speak(params={})
-            call_uuid = params.delete('call_uuid')
-            params.update({"text" => HTMLEntities.new(:html4).encode(params['text'], :decimal)})
-            return request('POST', "/Call/#{call_uuid}/Speak/", params)
-        end
-
-        def stop_speak(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('DELETE', "/Call/#{call_uuid}/Speak/", params)
-        end
-
-        def send_digits(params={})
-            call_uuid = params.delete('call_uuid')
-            return request('POST', "/Call/#{call_uuid}/DTMF/", params)
-        end
-
-        ## Calls requests ##
-        def hangup_request(params={})
-            request_uuid = params.delete('request_uuid')
-            return request('DELETE', "/Request/#{request_uuid}/", params)
-        end
-
-        ## Conferences ##
-        def get_live_conferences(params={})
-            return request('GET', "/Conference/", params)
-        end
-
-        def hangup_all_conferences(params={})
-            return request('DELETE', "/Conference/", params)
-        end
-
-        def get_live_conference(params={})
-            conference_name = params.delete('conference_name')
-            return request('GET', "/Conference/#{conference_name}/", params)
-        end
-
-        def hangup_conference(params={})
-            conference_name = params.delete('conference_name')
-            return request('DELETE', "/Conference/#{conference_name}/", params)
-        end
-
-        def hangup_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('DELETE', "/Conference/#{conference_name}/Member/#{member_id}/", params)
-        end
-
-        def play_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('POST', "/Conference/#{conference_name}/Member/#{member_id}/Play/", params)
-        end
-
-        def stop_play_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('DELETE', "/Conference/#{conference_name}/Member/#{member_id}/Play/", params)
-        end
-
-        def speak_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            params.update({"text" => HTMLEntities.new(:html4).encode(params['text'], :decimal)})
-            return request('POST', "/Conference/#{conference_name}/Member/#{member_id}/Speak/", params)
-        end
-
-        def stop_speak_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('DELETE', "/Conference/#{conference_name}/Member/#{member_id}/Speak/", params)
-        end
-
-        def deaf_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('POST', "/Conference/#{conference_name}/Member/#{member_id}/Deaf/", params)
-        end
-
-        def undeaf_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('DELETE', "/Conference/#{conference_name}/Member/#{member_id}/Deaf/", params)
-        end
-
-        def mute_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('POST', "/Conference/#{conference_name}/Member/#{member_id}/Mute/", params)
-        end
-
-        def unmute_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('DELETE', "/Conference/#{conference_name}/Member/#{member_id}/Mute/", params)
-        end
-
-        def kick_member(params={})
-            conference_name = params.delete('conference_name')
-            member_id = params.delete('member_id')
-            return request('POST', "/Conference/#{conference_name}/Member/#{member_id}/Kick/", params)
-        end
-
-        def record_conference(params={})
-            conference_name = params.delete('conference_name')
-            return request('POST', "/Conference/#{conference_name}/Record/", params)
-        end
-
-        def stop_record_conference(params={})
-            conference_name = params.delete('conference_name')
-            return request('DELETE', "/Conference/#{conference_name}/Record/", params)
-        end
-
-        ## Recordings ##
-        def get_recordings(params={})
-            return request('GET', "/Recording/", params)
-        end
-
-        def get_recording(params={})
-            recording_id = params.delete('recording_id')
-            return request('GET', "/Recording/#{recording_id}/", params)
-        end
-
-        def delete_recording(params={})
-            recording_id = params.delete('recording_id')
-            return request('DELETE', "/Recording/#{recording_id}/", params)
-        end
-
-        ## Endpoints ##
-        def get_endpoints(params={})
-            return request('GET', "/Endpoint/", params)
-        end
-
-        def create_endpoint(params={})
-            return request('POST', "/Endpoint/", params)
-        end
-
-        def get_endpoint(params={})
-            endpoint_id = params.delete('endpoint_id')
-            return request('GET', "/Endpoint/#{endpoint_id}/", params)
-        end
-
-        def modify_endpoint(params={})
-            endpoint_id = params.delete('endpoint_id')
-            return request('POST', "/Endpoint/#{endpoint_id}/", params)
-        end
-
-        def delete_endpoint(params={})
-            endpoint_id = params.delete('endpoint_id')
-            return request('DELETE', "/Endpoint/#{endpoint_id}/", params)
-        end
-
-        ## Incoming Carriers ##
-        def get_incoming_carriers(params={})
-            return request('GET', "/IncomingCarrier/", params)
-        end
-
-        def create_incoming_carrier(params={})
-            return request('POST', "/IncomingCarrier/", params)
-        end
-
-        def get_incoming_carrier(params={})
-            carrier_id = params.delete('carrier_id')
-            return request('GET', "/IncomingCarrier/#{carrier_id}/", params)
-        end
-
-        def modify_incoming_carrier(params={})
-            carrier_id = params.delete('carrier_id')
-            return request('POST', "/IncomingCarrier/#{carrier_id}/", params)
-        end
-
-        def delete_incoming_carrier(params={})
-            carrier_id = params.delete('carrier_id')
-            return request('DELETE', "/IncomingCarrier/#{carrier_id}/", params)
-        end
-
-        ## Outgoing Carriers ##
-        def get_outgoing_carriers(params={})
-            return request('GET', "/OutgoingCarrier/", params)
-        end
-
-        def create_outgoing_carrier(params={})
-            return request('POST', "/OutgoingCarrier/", params)
-        end
-
-        def get_outgoing_carrier(params={})
-            carrier_id = params.delete('carrier_id')
-            return request('GET', "/OutgoingCarrier/#{carrier_id}/", params)
-        end
-
-        def modify_outgoing_carrier(params={})
-            carrier_id = params.delete('carrier_id')
-            return request('POST', "/OutgoingCarrier/#{carrier_id}/", params)
-        end
-
-        def delete_outgoing_carrier(params={})
-            carrier_id = params.delete('carrier_id')
-            return request('DELETE', "/OutgoingCarrier/#{carrier_id}/", params)
-        end
-
-        ## Outgoing Carrier Routings ##
-        def get_outgoing_carrier_routings(params={})
-            return request('GET', "/OutgoingCarrierRouting/", params)
-        end
-
-        def create_outgoing_carrier_routing(params={})
-            return request('POST', "/OutgoingCarrierRouting/", params)
-        end
-
-        def get_outgoing_carrier_routing(params={})
-            routing_id = params.delete('routing_id')
-            return request('GET', "/OutgoingCarrierRouting/#{routing_id}/", params)
-        end
-
-        def modify_outgoing_carrier_routing(params={})
-            routing_id = params.delete('routing_id')
-            return request('POST', "/OutgoingCarrierRouting/#{routing_id}/", params)
-        end
-
-        def delete_outgoing_carrier_routing(params={})
-            routing_id = params.delete('routing_id')
-            return request('DELETE', "/OutgoingCarrierRouting/#{routing_id}/", params)
-        end
-
-        ## Pricing ##
-        def pricing(params={})
-            return request('GET', "/Pricing/", params)
-        end
-
-        ## Outgoing Carrier ##
-
-        ## To be added here ##
-
-        ## Message ##
-        def send_message(params={})
-            return request('POST', "/Message/", params)
-        end
-
-        def get_messages(params={})
-            return request('GET', "/Message/", params)
-        end
-
-        def get_message(params={})
-            record_id = params.delete('record_id')
-            return request('GET', "/Message/#{record_id}/", params)
-        end
-    end
-
-
-
-    class Element
-        class << self
-            attr_accessor :valid_attributes, :nestables
-        end
-        @nestables = []
-        @valid_attributes = []
-
-        attr_accessor :node, :name
-
-        def initialize(body=nil, attributes={}, &block)
-            @name = self.class.name.split('::')[1]
-            @body = body
-            @node = REXML::Element.new @name
-            attributes.each do |k, v|
-                if self.class.valid_attributes.include?(k.to_s)
-                    @node.attributes[k.to_s] = convert_value(v)
-                else
-                    raise PlivoError, "invalid attribute #{k.to_s} for #{@name}"
-                end
-            end
-
-            if @body
-                @node.text = @body
-            end
-
-            # Allow for nested "nestable" elements using a code block
-            # ie
-            # Plivo::Response.new do |r|
-            #   r.Dial do |n|
-            #     n.Number '+15557779999'
-            #   end
-            # end
-            yield(self) if block_given?
-        end
-
-        def method_missing(method, *args, &block)
-            # Handle the addElement methods
-            method = $1.to_sym if method.to_s =~ /^add(.*)/
-                # Add the element
-                add(Plivo.const_get(method).new(*args, &block))
-        end
-
-
-        def convert_value(v)
-            if v == true
-                return "true"
-            elsif v == false
-                return "false"
-            elsif v == nil
-                return "none"
-            elsif v == "get"
-                return "GET"
-            elsif v == "post"
-                return "POST"
-            else
-                return v
-            end
-        end
-
-        def add(element)
-            if not element
-                raise PlivoError, "invalid element"
-            end
-            if self.class.nestables.include?(element.name)
-                @node.elements << element.node
-                return element
-            else
-                raise PlivoError, "#{element.name} not nestable in #{@name}"
-            end
-        end
-
-        def to_xml
-            return @node.to_s
-        end
-
-        def to_s
-            return @node.to_s
-        end
-    end
-
-
-    class Response < Element
-        @nestables = ['Speak', 'Play', 'GetDigits', 'Record', 'Dial', 'Message',
-            'Redirect', 'Wait', 'Hangup', 'PreAnswer', 'Conference', 'DTMF']
-        @valid_attributes = []
-
-        def initialize()
-            super(nil, {})
-        end
-
-        def to_xml()
-            return '<?xml version="1.0" encoding="utf-8" ?>' + super()
-        end
-
-        def to_s()
-            return '<?xml version="1.0" encoding="utf-8" ?>' + super()
-        end
-    end
-
-
-    class Speak < Element
-        @nestables = []
-        @valid_attributes = ['voice', 'language', 'loop']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError, 'No text set for Speak'
-            else
-                body = HTMLEntities.new(:html4).encode(body, :decimal)
-            end
-            super(body, attributes)
-        end
-    end
-
-
-    class Play < Element
-        @nestables = []
-        @valid_attributes = ['loop']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError 'No url set for Play'
-            end
-            super(body, attributes)
-        end
-    end
-
-
-    class Wait < Element
-        @nestables = []
-        @valid_attributes = ['length', 'silence', 'min_silence', 'beep']
-
-        def initialize(attributes={})
-            super(nil, attributes)
-        end
-    end
-
-
-    class Redirect < Element
-        @nestables = []
-        @valid_attributes = ['method']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError 'No url set for Redirect'
-            end
-            super(body, attributes)
-        end
-    end
-
-
-    class Hangup < Element
-        @nestables = []
-        @valid_attributes = ['schedule', 'reason']
-
-        def initialize(attributes={})
-            super(nil, attributes)
-        end
-    end
-
-
-    class GetDigits < Element
-        @nestables = ['Speak', 'Play', 'Wait']
-        @valid_attributes = ['action', 'method', 'timeout', 'digitTimeout',
-            'numDigits', 'retries', 'invalidDigitsSound',
-            'validDigits', 'playBeep', 'redirect', "finishOnKey",
-            'digitTimeout', 'log']
-
-        def initialize(attributes={}, &block)
-            super(nil, attributes, &block)
-        end
-    end
-
-
-    class Number < Element
-        @nestables = []
-        @valid_attributes = ['sendDigits', 'sendOnPreanswer']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError, 'No number set for Number'
-            end
-            super(body, attributes)
-        end
-    end
-
-
-    class User < Element
-        @nestables = []
-        @valid_attributes = ['sendDigits', 'sendOnPreanswer', 'sipHeaders']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError, 'No user set for User'
-            end
-            super(body, attributes)
-        end
-    end
-
-
-    class Dial < Element
-        @nestables = ['Number', 'User']
-        @valid_attributes = ['action','method','timeout','hangupOnStar',
-            'timeLimit','callerId', 'callerName', 'confirmSound',
-            'dialMusic', 'confirmKey', 'redirect',
-            'callbackUrl', 'callbackMethod', 'digitsMatch', 'digitsMatchBLeg',
-            'sipHeaders']
-
-        def initialize(attributes={}, &block)
-            super(nil, attributes, &block)
-        end
-    end
-
-
-    class Conference < Element
-        @nestables = []
-        @valid_attributes = ['muted','beep','startConferenceOnEnter',
-            'endConferenceOnExit','waitSound','enterSound', 'exitSound',
-            'timeLimit', 'hangupOnStar', 'maxMembers',
-            'record', 'recordFileFormat', 'action', 'method', 'redirect',
-            'digitsMatch', 'callbackUrl', 'callbackMethod',
-            'stayAlone', 'floorEvent',
-            'transcriptionType', 'transcriptionUrl',
-            'transcriptionMethod', 'recordWhenAlone', 'relayDTMF']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError, 'No conference name set for Conference'
-            end
-            super(body, attributes)
-        end
-    end
-
-
-    class Record < Element
-        @nestables = []
-        @valid_attributes = ['action', 'method', 'timeout','finishOnKey',
-            'maxLength', 'playBeep', 'recordSession',
-            'startOnDialAnswer', 'redirect', 'fileFormat',
-            'callbackUrl', 'callbackMethod',
-            'transcriptionType', 'transcriptionUrl',
-            'transcriptionMethod']
-
-        def initialize(attributes={})
-            super(nil, attributes)
-        end
-    end
-
-
-    class PreAnswer < Element
-        @nestables = ['Play', 'Speak', 'GetDigits', 'Wait', 'Redirect', 'Message', 'DTMF']
-        @valid_attributes = []
-
-        def initialize(attributes={}, &block)
-            super(nil, attributes, &block)
-        end
-    end
-
-
-    class Message < Element
-        @nestables = []
-        @valid_attributes = ['src', 'dst', 'type', 'callbackUrl', 'callbackMethod']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError, 'No text set for Message'
-            end
-            super(body, attributes)
-        end
-    end
-
-    class DTMF < Element
-        @nestables = []
-        @valid_attributes = ['async']
-
-        def initialize(body, attributes={})
-            if not body
-                raise PlivoError, 'No digits set for DTMF'
-            end
-            super(body, attributes)
-        end
-    end
-
-end
+require_relative 'plivo/version'
+require_relative 'plivo/exceptions'
+require_relative 'plivo/utils'
+require_relative 'plivo/base'
+require_relative 'plivo/resources'
+require_relative 'plivo/rest_client'
+require_relative 'plivo/xml'
+
+module Plivo; end