Rename Bandwith -> OldBandwidth

Author: canaandavis

README.md

@@ -1,27 +1,29 @@
 # ruby-bandwidth
 
-[![Build](https://travis-ci.org/Bandwidth/ruby-bandwidth.png)](https://travis-ci.org/Bandwidth/ruby-bandwidth)
-
-Bandwidth [Bandwidth's App Platform](http://ap.bandwidth.com/?utm_medium=social&utm_source=github&utm_campaign=dtolb&utm_content=) Ruby SDK
-
-With ruby-bandwidth  you have access to the entire set of API methods including:
-* **Account** - get user's account data and transactions,
-* **Application** - manage user's applications,
-* **AvailableNumber** - search free local or toll-free phone numbers,
-* **Bridge** - control bridges between calls,
-* **Call** - get access to user's calls,
-* **Conference** - manage user's conferences,
-* **ConferenceMember** - make actions with conference members,
-* **Domain** - get access to user's domains,
-* **EntryPoint** - control of endpoints of domains,
-* **Error** - list of errors,
-* **Media** - list, upload and download files to Bandwidth API server,
-* **Message** - send SMS/MMS, list messages,
-* **NumberInfo** - receive CNUM info by phone number,
-* **PhoneNumber** - get access to user's phone numbers,
-* **Recording** - mamange user's recordings.
-
-Also you can work with Bandwidth XML using special types (in namespace `Bandwidth::Xml`). 
+[![Build](https://travis-ci.org/OldBandwidth/ruby-bandwidth.png)](https://travis-ci.org/OldBandwidth/ruby-bandwidth)
+
+OldBandwidth [OldBandwidth's App Platform](http://ap.bandwidth.com/?utm_medium=social&utm_source=github&utm_campaign=dtolb&utm_content=) Ruby SDK
+
+With ruby-bandwidth you have access to the entire set of API methods including:
+
+- **Account** - get user's account data and transactions,
+- **Application** - manage user's applications,
+- **AvailableNumber** - search free local or toll-free phone numbers,
+- **Bridge** - control bridges between calls,
+- **Call** - get access to user's calls,
+- **Conference** - manage user's conferences,
+- **ConferenceMember** - make actions with conference members,
+- **Domain** - get access to user's domains,
+- **EntryPoint** - control of endpoints of domains,
+- **Error** - list of errors,
+- **Media** - list, upload and download files to OldBandwidth API server,
+- **Message** - send SMS/MMS, list messages,
+- **NumberInfo** - receive CNUM info by phone number,
+- **PhoneNumber** - get access to user's phone numbers,
+- **Recording** - mamange user's recordings.
+
+Also you can work with OldBandwidth XML using special types (in namespace `OldBandwidth::Xml`).
+
 ## Install
 
 Via rubygems:
@@ -32,93 +34,91 @@ or add to your Gemfile:
 
     gem "ruby-bandwidth"
 
-
 ## Getting Started
 
-* Install `ruby-bandwidth`,
-* **Get user id, api token and secret** - to use the Catapult API you need these data.  You can get them [here](https://catapult.inetwork.com/pages/catapult.jsf) on the tab "Account",
-* **Set user id, api token and secret** - you can do that with 2 ways:
+- Install `ruby-bandwidth`,
+- **Get user id, api token and secret** - to use the Catapult API you need these data. You can get them [here](https://catapult.inetwork.com/pages/catapult.jsf) on the tab "Account",
+- **Set user id, api token and secret** - you can do that with 2 ways:
 
 ```ruby
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+
 # Or you can use default client instance
 # Do that only once
   Client.global_options = {:user_id => "userId", :api_token => "token", :api_secret => "secret"}
 ```
 
-
-
 ## Usage
 
 All "static" (classs) functions support 2 ways to be called: with client instance as first arg or without client instance (default client instance will be used then)
 
 ```ruby
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  calls = Bandwidth::Call.list(client, {:page => 1})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  calls = OldBandwidth::Call.list(client, {:page => 1})
 
 # Or you can use default client instance
 # You should set up its global options before using of api functions
-  calls = Bandwidth::Call.list(:page=>1)
+  calls = OldBandwidth::Call.list(:page=>1)
 ```
 
 Read [Catapult Api documentation](https://catapult.inetwork.com/docs/api-docs/) for more details
 
 ## Examples
-*All examples assume you have already setup your auth data!*
+
+_All examples assume you have already setup your auth data!_
 
 List all calls from special number
 
 ```ruby
-  calls = Bandwidth::Call.list({:from => "+19195551212"})
+  calls = OldBandwidth::Call.list({:from => "+19195551212"})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  calls = Bandwidth::Call.list(client, {:from => "+19195551212"})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  calls = OldBandwidth::Call.list(client, {:from => "+19195551212"})
 ```
 
 List all received messages
 
 ```ruby
-  messages = Bandwidth::Message.list({:state => "received"})
+  messages = OldBandwidth::Message.list({:state => "received"})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  messages = Bandwidth::Message.list(client, {:state => "received"})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  messages = OldBandwidth::Message.list(client, {:state => "received"})
 ```
 
 Send SMS
 
 ```ruby
-  message = Bandwidth::Message.create({:from => "+19195551212", :to => "+191955512142", :text => "Test"})
+  message = OldBandwidth::Message.create({:from => "+19195551212", :to => "+191955512142", :text => "Test"})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  message = Bandwidth::Message.create(client, {:from => "+19195551212", :to => "+191955512142", :text => "Test"})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  message = OldBandwidth::Message.create(client, {:from => "+19195551212", :to => "+191955512142", :text => "Test"})
 ```
 
 Send some SMSes
 
 ```ruby
-  statuses = Bandwidth::Message.create([{:from => "+19195551212", :to => "+191955512142", :text => "Test"}, {:from => "+19195551212", :to => "+191955512143", :text => "Test2"}])
+  statuses = OldBandwidth::Message.create([{:from => "+19195551212", :to => "+191955512142", :text => "Test"}, {:from => "+19195551212", :to => "+191955512143", :text => "Test2"}])
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  statuses = Bandwidth::Message.create(client, [{:from => "+19195551212", :to => "+191955512142", :text => "Test"}, {:from => "+19195551212", :to => "+191955512143", :text => "Test2"}])
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  statuses = OldBandwidth::Message.create(client, [{:from => "+19195551212", :to => "+191955512142", :text => "Test"}, {:from => "+19195551212", :to => "+191955512143", :text => "Test2"}])
 ```
 
-Upload file 
+Upload file
 
 ```ruby
-  Bandwidth::Media.upload("avatar.png", File.open("/local/path/to/file.png", "r"), "image/png")
+  OldBandwidth::Media.upload("avatar.png", File.open("/local/path/to/file.png", "r"), "image/png")
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  Bandwidth::Media.upload(client, "avatar.png", File.open("/local/path/to/file.png", "r"), "image/png")
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  OldBandwidth::Media.upload(client, "avatar.png", File.open("/local/path/to/file.png", "r"), "image/png")
 ```
 
 Make a call
 
 ```ruby
-  call = Bandwidth::Call.create({:from => "+19195551212", :to => ""+191955512142"})
+  call = OldBandwidth::Call.create({:from => "+19195551212", :to => ""+191955512142"})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  call = Bandwidth::Call.create(client, {:from => "+19195551212", :to => ""+191955512142"})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  call = OldBandwidth::Call.create(client, {:from => "+19195551212", :to => ""+191955512142"})
 ```
 
 Reject incoming call
@@ -128,68 +128,71 @@ Reject incoming call
 ```
 
 Create a gather
+
 ```ruby
   gather = call.create_gather({:max_digits => 3, :inter_digit_timeout => 5, :prompt => {:sentence => "Please enter 3 digits"}})
 ```
 
 Start a conference
+
 ```ruby
-  conference = Bandwidth::Conference.create({:from => "+19195551212"})
+  conference = OldBandwidth::Conference.create({:from => "+19195551212"})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  conference = Bandwidth::Conference.create(client, {:from => "+19195551212"})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  conference = OldBandwidth::Conference.create(client, {:from => "+19195551212"})
 ```
 
 Connect 2 calls to a bridge
 
 ```ruby
-  bridge = Bandwidth::Bridge.create({:call_ids => [call_id1, call_id2]})
+  bridge = OldBandwidth::Bridge.create({:call_ids => [call_id1, call_id2]})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  bridge = Bandwidth::Bridge.create(client, {:call_ids => [call_id1, call_id2]})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  bridge = OldBandwidth::Bridge.create(client, {:call_ids => [call_id1, call_id2]})
 ```
 
 Search available local numbers to buy
 
 ```ruby
-  numbers = Bandwidth::AvailableNumber.search_local({:state =>"NC", :city => "Cary"})
+  numbers = OldBandwidth::AvailableNumber.search_local({:state =>"NC", :city => "Cary"})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  numbers = Bandwidth::AvailableNumber.search_local(client, {:state =>"NC", :city => "Cary"})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  numbers = OldBandwidth::AvailableNumber.search_local(client, {:state =>"NC", :city => "Cary"})
 ```
+
 Get CNAM info for a number
 
 ```ruby
-  info = Bandwidth::NumberInfo.get("+19195551212")
+  info = OldBandwidth::NumberInfo.get("+19195551212")
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  info = Bandwidth::NumberInfo.get(client, "+19195551212")
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  info = OldBandwidth::NumberInfo.get(client, "+19195551212")
 ```
 
 Buy a phone number
 
 ```ruby
-  number = Bandwidth::PhoneNumber.create({:number => "+19195551212"})
+  number = OldBandwidth::PhoneNumber.create({:number => "+19195551212"})
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  number = Bandwidth::PhoneNumber.create(client, {:number => "+19195551212"})
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  number = OldBandwidth::PhoneNumber.create(client, {:number => "+19195551212"})
 ```
 
 List recordings
 
 ```ruby
-  list = Bandwidth::Recording.list()
+  list = OldBandwidth::Recording.list()
   #or
-  client = Bandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
-  list = Bandwidth::Recording.list(client)
+  client = OldBandwidth::Client.new(:user_id => "userId", :api_token => "token", :api_secret => "secret")
+  list = OldBandwidth::Recording.list(client)
 ```
 
-Generate Bandwidth XML
+Generate OldBandwidth XML
 
 ```ruby
-  response = Bandwidth::Xml::Response.new()
-  speak_sentence = Bandwidth::Xml::Verbs::SpeakSentence.new({:sentence => "Transferring your call, please wait.", :voice => "paul", :gender => "male", :locale => "en_US"})
-  transfer = Bandwidth::Xml::Verbs::Transfer.new({
+  response = OldBandwidth::Xml::Response.new()
+  speak_sentence = OldBandwidth::Xml::Verbs::SpeakSentence.new({:sentence => "Transferring your call, please wait.", :voice => "paul", :gender => "male", :locale => "en_US"})
+  transfer = OldBandwidth::Xml::Verbs::Transfer.new({
             :transfer_to => "+13032288849",
             :transfer_caller_id => "private",
             :speak_sentence => {
@@ -200,27 +203,27 @@ Generate Bandwidth XML
             }
         })
 
-  hangup = Bandwidth::Xml::Verbs::Hangup.new()
-  response << speak_sentence << transfer << hangup 
+  hangup = OldBandwidth::Xml::Verbs::Hangup.new()
+  response << speak_sentence << transfer << hangup
 
   # as alternative way we can pass list of verbs to constructor of Response
-  # response = Bandwidth::Xml::Response.new([speak_sentence, transfer, hangup])
+  # response = OldBandwidth::Xml::Response.new([speak_sentence, transfer, hangup])
 
   puts response.to_xml()
 ```
 
-
 See directory `samples` for more examples.
 See [ruby-bandwidth-example](https://github.com/bandwidthcom/ruby-bandwidth-example) for more complex examples of using this module.
 
 ### Messaging 2.0
+
 Send SMS (v2)
 
 ```ruby
   auth_data = {user_name: 'user', password: 'password', account_id: 'accountId', subaccount_id: 'subaccountId'}
 
-  # Before sending sms you should have nessagin application on Bandwidth dashboard. You should create it by next call
-  application = Bandwidth::V2::Message.create_messaging_application(auth_data, {
+  # Before sending sms you should have nessagin application on OldBandwidth dashboard. You should create it by next call
+  application = OldBandwidth::V2::Message.create_messaging_application(auth_data, {
       :name => 'My messaging application',
       :callback_url => 'http://server/to/handle/messages/events',
       :location_name => 'current',
@@ -229,7 +232,7 @@ Send SMS (v2)
       :mms_options => {:enabled => true}
   })
 
-  # After that you should reserve 1 or some phone nubmers on Bandwidth Dashboard
+  # After that you should reserve 1 or some phone nubmers on OldBandwidth Dashboard
   numbers = Message.search_and_order_numbers(auth_data, application) do |query|
       query.AreaCodeSearchAndOrderType do |b|
          b.AreaCode("910")
@@ -238,7 +241,7 @@ Send SMS (v2)
   end
 
   # Now you can send messages from reserved numbers. Don't forget to pass :application_id
-  message = Bandwidth::V2::Message.create({:from => numbers[0], :to => ["+191955512142"], :text => "Test", :application_id => application[:application_id]})
+  message = OldBandwidth::V2::Message.create({:from => numbers[0], :to => ["+191955512142"], :text => "Test", :application_id => application[:application_id]})
 ```
 
 # Documentation generation
@@ -248,4 +251,5 @@ Generates documentation:
     yard doc
 
 # Samples
+
 [More sample applications](https://github.com/bandwidthcom/ruby-bandwidth-example)

lib/bandwidth/account.rb lib/old_bandwidth/account.rblib/bandwidth/account.rb renamed to lib/old_bandwidth/account.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   ACCOUNT_PATH = 'account'
   # Account API allows you to retrieve your current balance, transaction list, account type and all elements related to your platform account.
   class Account

lib/bandwidth/api_item.rb lib/old_bandwidth/api_item.rblib/bandwidth/api_item.rb renamed to lib/old_bandwidth/api_item.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   # Module which adds common operations for all Catapult api related classes
   module ApiItem
     # Initializer

lib/bandwidth/application.rb lib/old_bandwidth/application.rblib/bandwidth/application.rb renamed to lib/old_bandwidth/application.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   APPLICATION_PATH = 'applications'
   # The Applications resource lets you define call and message handling applications
   class Application

lib/bandwidth/available_number.rb lib/old_bandwidth/available_number.rblib/bandwidth/available_number.rb renamed to lib/old_bandwidth/available_number.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   AVAILABLE_NUMBER_PATH = 'availableNumbers'
 
   # The Available Numbers resource lets you search for numbers that are available for use with your application.

lib/bandwidth/bridge.rb lib/old_bandwidth/bridge.rblib/bandwidth/bridge.rb renamed to lib/old_bandwidth/bridge.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   BRIDGE_PATH = 'bridges'
 
   # Bridges resource. Bridge two calls allowing two way audio between them.

lib/bandwidth/call.rb lib/old_bandwidth/call.rblib/bandwidth/call.rb renamed to lib/old_bandwidth/call.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   CALL_PATH = 'calls'
 
   # The Calls resource lets you make phone calls and view information about previous inbound and outbound calls.

lib/bandwidth/client.rb lib/old_bandwidth/client.rblib/bandwidth/client.rb renamed to lib/old_bandwidth/client.rb

@@ -3,7 +3,7 @@
 require 'json'
 require 'active_support/core_ext/string/inflections'
 
-module Bandwidth
+module OldBandwidth
 
   # Catapult client class. It is used by any api related class
   class Client
@@ -43,7 +43,7 @@ def initialize (user_id = nil, api_token = nil, api_secret = nil, api_endpoint =
         Faraday.new(api_endpoint) { |faraday|
           faraday.basic_auth(api_token, api_secret)
           faraday.headers['Accept'] = 'application/json'
-          faraday.headers['User-Agent'] = "ruby-bandwidth/v#{Bandwidth::VERSION}"
+          faraday.headers['User-Agent'] = "ruby-bandwidth/v#{OldBandwidth::VERSION}"
           @set_adapter.call(faraday)
           configure_connection.call(faraday) if configure_connection
         }

lib/bandwidth/client_wrapper.rb lib/old_bandwidth/client_wrapper.rblib/bandwidth/client_wrapper.rb renamed to lib/old_bandwidth/client_wrapper.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   # Allows to make first argument (client instance) of defined singletom function optional
   module ClientWrapper
     # Make first argument (client instance) of a method optional

lib/bandwidth/conference.rb lib/old_bandwidth/conference.rblib/bandwidth/conference.rb renamed to lib/old_bandwidth/conference.rb

@@ -1,4 +1,4 @@
-module Bandwidth
+module OldBandwidth
   CONFERENCE_PATH = 'conferences'
   #The Conference resource allows you create conferences, add members to it, play audio and other things related to conferencing.
   class Conference