ruby-bandwidth-iris 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 538d68fb402de2a2d2e6205243b35c9e234d2470
+  data.tar.gz: 6fa4ef1e716a3cd1cba14b08a84636225f623169
+SHA512:
+  metadata.gz: 36d2daed8eaa6e88775d8fbd2d0e1f7c5ca4c86223c8d28d903d5d425cc5bf061f4e78cc8a7de87d4060142df052c2e338a53a52574c93635c938ab46402b2d9
+  data.tar.gz: 833a20b387718587bf59e6c94e7c8c66fd2d8069eb57050f701a97df1e7009230bc7b2b549619560c3a6de2a6fc509bf9c500808acd28eb0cf9dd687076b60e0

data/.editorconfig

@@ -0,0 +1,13 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,12 @@
+.ruby-version
+pkg/*
+Gemfile.lock
+doc
+coverage
+*.gem
+.bundle
+*.log
+*.swp
+*.swo
+.yardoc
+examples/config.yml

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--require helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - '1.9.3'
+  - '2.0.0'
+  - '2.1.0'
+  - '2.2.0'
+

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+gem 'rake'
+
+group :test do
+  gem 'coveralls'
+  gem 'rspec', '>= 2.14'
+  gem 'simplecov'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License
+
+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

@@ -0,0 +1,571 @@
+# ruby-bandwidth-iris
+
+[![Build](https://travis-ci.org/bandwidthcom/ruby-bandwidth-Bandwidth::png)](https://travis-ci.org/bandwidthcom/ruby-bandwidth-iris)
+
+Ruby Client library for IRIS / BBS API
+
+## Install
+
+Run
+
+```
+gem install ruby-bandwidth-iris
+```
+
+## Usage
+
+```ruby
+require 'ruby-bandwidth-iris'
+
+# Using  directly
+client = BandwidthIris::Client.new('accountId', 'userName', 'password')
+sites = BandwidthIris::Site.list(client)
+
+# Or you can use default client instance (do this only once)
+BandwidthIris::Client.global_options = {
+  :account_id => 'accountId',
+  :username => 'userName',
+  :password => 'password'
+}
+
+# Now you can call any functions without first arg 'client'
+
+sites = BandwidthIris::Site.list()
+
+```
+
+## Examples
+There is an 'examples' folder in the source tree that shows how each of the API objects work with simple example code.  To run the examples:
+
+```bash
+$ cd examples
+$ cp config.yml.example config.yml
+```
+Edit the config.yml to match your IRIS credentials and run the examples individually.  e.g.
+
+```bash
+ruby covered_rate_centers.rb
+```
+If the examples take command line parameters, you will get the usage by just executing the individual script.
+
+
+## API Objects 
+### General principles
+When fetching objects from the API, it will always return an object that has the client
+instantiated so that you can call dependent methods as well as update, delete.
+
+Example:
+```ruby
+site = BandwidthIris::Site.create({siteObject})
+
+# or
+
+site = BandwidthIris::Site.create(client, {siteObject})
+
+```
+
+Each entity has a get, list, create, update and delete method if appropriate.
+
+All properties are underscored and low-cased for Ruby readability, and are converted on the fly to the proper 
+case by the internals of the API when converted to XML.
+
+## Available Numbers
+
+```Ruby
+list = BandwidthIris::AvailableNumbers.list(query)
+```
+
+## Available NpaNxx
+```ruby
+list = BandwidthIris::AvailableNpaNxx.list({:area_code => "818", :quantity =>5})
+```
+
+## Cities
+```ruby
+list = Bandwidth::City.list(:available => true, :state =>"CA"})
+```
+
+## Covered Rate Centers
+```ruby
+Bandwidth::CoveredRateCenter.list({:zip => "27601"})
+```
+
+## Disconnected Numbers
+Retrieves a list of disconnected numbers for an account
+```ruby
+Bandwidth::DiscNumber.list({:area_code => "919"})
+```
+
+## Disconnect Numbers 
+The Disconnect object is used to disconnect numbers from an account.  Creates a disconnect order that can be tracked
+
+### Create Disconnect
+```ruby
+Bandwidth::Disconnect.create("Disconnect Order Name", ["9195551212", "9195551213"])
+```
+
+### Add Note to Disconnect
+```ruby
+order.add_note({:user_id => "my id", :description => "Test"})
+```
+
+### Get Notes for Disconnect
+```ruby
+order.get_notes()
+```
+
+## Dlda
+
+### Create Ddla
+```ruby
+dlda = {
+  :customer_order_id => "Your Order Id",
+  :dlda_tn_groups => [
+    :dlda_tn_group => {
+      :telephone_numbers => ["9195551212"],
+      :subscriber_type => "RESIDENTIAL",
+      :listing_type => "LISTED",
+      :listing_name => {
+        :first_name => "John",
+        :last_name => "Smith"
+      },
+      :list_address => true,
+      :address => {
+        :house_number => "123",
+        :street_name => "Elm",
+        :street_suffix => "Ave",
+        :city => "Carpinteria",
+        :state_code => "CA",
+        :zip => "93013",
+        :address_type => "DLDA"
+      }
+    }
+  ]
+}
+
+Bandwidth::Dlda.create(dlda)
+```
+
+### Get Dlda
+```ruby
+dlda = Bandwidth::Dlda.get(id)
+```
+
+### Get Dlda History
+```ruby
+dlda.get_history()
+```
+
+### List Dldas
+```ruby
+Bandwidth::Dlda.list({:telephone_number => "9195551212"})
+```
+
+## Import To Account
+This path is generally not available to Bandwidth accounts, and as such is not documented in this API
+
+## In Service Numbers
+
+### List InService Numbers
+```ruby
+Bandwidth::InServiceNumber.list({:area_code => "919"})
+```
+
+### Get InService Number Detail
+```ruby
+Bandwidth::InServiceNumber.get("9195551212")
+```
+
+## Lidb
+
+### Create
+```ruby
+data = {
+  :customer_order_id => "A test order",
+  :lidb_tn_groups => {
+    :lidb_tn_group => {
+      :telephone_numbers => ["8048030097", "8045030098"],
+      :subscriber_information => "Joes Grarage",
+      :use_type => "RESIDENTIAL",
+      :visibility => "PUBLIC"
+    }
+  }
+}
+Bandwidth::Lidbs.create(data)
+```
+### Get Lidb
+```ruby
+Bandwidth::Lidbs.get(id)
+```
+### List Lidbs
+```ruby
+Bandwidth::Lidbs.list({:telephone_number => "9195551212"})
+```
+
+## LNP Checker
+### Check LNP
+```ruby
+numbers = ["9195551212", "9195551213"]
+full_check = true
+Bandwidth::LnpChecker.check(numbers, full_check)
+```
+
+## LSR Orders
+### Create LSR Order
+```ruby
+data = {
+  :pon => "Some Pon",
+  :customer_order_id => "MyId5",
+  'sPID' => "123C",
+  :billing_telephone_number => "9192381468",
+  :requested_foc_date => "2015-11-15",
+  :authorizing_person => "Jim Hopkins",
+  :subscriber => {
+    :subscriber_type => "BUSINESS",
+    :business_name => "BusinessName",
+    :service_address => {
+      :house_number => "11",
+      :street_name => "Park",
+      :street_suffix => "Ave",
+      :city => "New York",
+      :state_code => "NY",
+      :zip => "90025"
+    },
+    :account_number => "123463",
+    :pin_number => "1231"
+  },
+  :list_of_telephone_numbers => {
+    :telephone_number => ["9192381848", "9192381467"]
+  }
+}
+
+Bandwidth::LsrOrder.create(data)
+```
+### Get LSR Order
+```ruby
+Bandwidth::LsrOrder.get(id)
+```
+### List LSR Orders
+```ruby
+Bandwidth::LsrOrder.list({:pon =>"Some Pon"})
+```
+### Update LSR Order
+```ruby
+order.requestedFocDate = "2015-11-16"
+Bandwidth::LsrOrder.update(order)
+```
+### Get LSR Order History
+```ruby
+order.get_history()
+```
+### Get LSR Order Notes
+```ruby
+order.get_notes()
+```
+### Add LSR Order Note
+```ruby
+var note = {:user_id => "my id", :description => "Test"}
+order.add_note(note)
+```
+
+## Orders
+### Create Order
+```ruby
+order = {
+  :name => "A Test Order",
+  :site_id => 1111,
+  :existing_telephone_number_order_type => {
+    telephone_number_list =>
+      {
+        :telephone_number => ["9195551212"]
+      }
+    
+  }
+}
+
+Bandwidth::Order.create(order)
+```
+### Get Order
+```ruby
+Bandwidth::Order.get(id)
+```
+### List Orders
+```ruby
+Bandwidth::Order.list(query)
+```
+### Order Instance Methods 
+```ruby
+// get Area Codes
+order.get_area_codes()
+
+// add note to order
+var note = {:user_id => "my id", :description => "Test"}
+order.add_note(note)
+
+//get Npa Nxxs
+order.get_npa_nxx()
+
+// get number totals
+order.get_totals()
+
+// get all Tns for an order
+order.get_tns()
+
+// get order history
+order.get_history()
+
+// get order notes
+order.get_notes()
+```
+
+## Port Ins
+### Create PortIn
+```ruby
+data = {
+  :site_id =>1234,
+  :peer_id => 5678,
+  :billing_telephone_number => "9195551212",
+  :subscriber => {
+    :subscriber_type => "BUSINESS",
+    :business_name => "Company",
+    :service_address => {
+      :house_number => "123",
+      :street_name => "EZ Street",
+      :city => "Raleigh",
+      :state_code => "NC",
+      :county => "Wake"
+    }
+  }, 
+  :loa_authorizing_person => "Joe Blow",
+  :list_of_phone_numbers => {
+    :phone_number => ["9195551212"]
+  },
+  :billing_type => "PORTIN"
+}
+
+Bandwidth::PortIn.create(data)
+```
+## Get PortIn
+```ruby
+Bandwidth::PortIn.get("id", callback)
+```
+
+### PortIn Instance methods
+```ruby
+portIn.update(data)
+portIn.delete()
+```
+### PortIn File Management
+```ruby
+
+# Add File
+portIn.create_file(IO.read("myFile.txt"))
+
+# Update File
+portIn.update_file("myFile.txt", IO.read("myFile.txt"))
+
+# Get File
+portIn.get_file("myFile.txt")
+
+# Get File Metadata
+portIn.get_file_metadata("myFile.txt")
+
+# Get Files
+portIn.get_files()
+```
+
+## Port Out
+### List PortOuts
+```ruby
+query = {:status => "complete"}
+Bandwidth::PortOut.list(query)
+```
+### Get PortOut
+```ruby
+Bandwidth::PortOut.get(id)
+```
+
+## Rate Centers
+### List Ratecenters
+```ruby
+query = {:available => true, :state => "CA"}
+Bandwidth::RateCenter.list(query)
+```
+
+## SIP Peers
+### Create SIP Peer
+```ruby
+data = {
+  :peer_name => "A New SIP Peer",
+  :is_default_peer => false, 
+  :short_messaging_protocol =>"SMPP",
+  :site_id => selectedSite, 
+  :voice_hosts =>
+    {
+      :host => [{
+        :host_name => "1.1.1.1"
+      }]
+    },
+  :sms_hosts =>
+    {
+      :host => [{
+        :host_name => "1.1.1.1"
+      }]
+    },
+  :termination_hosts => 
+    {
+        :termination_host =>[{
+        :host_name => "1.1.1.1",
+        :port => 5060
+      }]
+    }
+  
+}
+
+Bandwidth::SipPeer.create(data)
+```
+### Get SIP Peer
+```ruby
+Bandwidth::SipPeer.get("id")
+```
+### List SIP Peers
+```ruby
+Bandwidth::SipPeer.list(siteId)
+```
+### Delete SIP Peer
+```ruby
+sipPeer.delete()
+```
+### SipPeer TN Methods
+```ruby
+# get TN for this peer
+sipPeer.get_tns(number)  
+
+# get all TNs for this peer
+sipPeer.get_tns()
+
+# Update TNs for this peer
+tns = {:full_number => "123456", :rewrite_user => "test"}
+sipPeer.update_tns(number, tns)
+
+#  Move Tns to new peer
+numbers_to_move = ["9195551212", "9195551213"]
+sipPeer.move_tns(numbers_to_move)
+```
+
+## Sites
+
+### Create A Site
+A site is what is called Location in the web UI. 
+```ruby
+site = {
+  :name =>"A new site",
+  :description =>"A new description",
+  :address => {
+    :house_number => "123",
+    :street_name => "Anywhere St",
+    :city => "Raleigh",
+    :state_code =>"NC",
+    :zip => "27609",
+    :address_type => "Service"
+  }
+};
+Bandwidth::Site.create(site)
+```
+
+### Updating a Site
+```ruby
+site.update({:name => "New name"})
+```
+### Deleting a Site
+```ruby
+site.delete()
+```
+### Listing All Sites
+```ruby
+Bandwidth::Site.list()
+```
+```
+### Site SipPeer Methods
+```ruby
+# get Sip Peers
+site.get_sip_peers()
+
+# get Sip Peer
+site.get_sip_peer(id)
+
+# create Sip Peer
+sip_peer = {:name =>"SIP Peer"}
+site.create_sip_peer(sipPeer)
+```
+
+## Subscriptions
+### Create Subscription
+```ruby
+subscription = {
+  :order_type => "orders",
+  :callback_subcription => {
+    :url => "http://mycallbackurl.com",
+    :user => "userid",
+    :expiry => 12000
+  }
+}
+Bandwidth::Subscription.create(subscription)
+```
+### Get Subscription
+```ruby
+Bandwidth::Subscription.get(id)
+```
+### List Subscriptions
+```ruby
+Bandwidth::Subscription.list(query)
+```
+### Subscription Instance Methods
+```ruby
+# update subscription
+updatedData = {:order_type => "portins"}
+subscription.update(updatedData)
+
+# delete subscription
+subscription.delete()
+});
+```
+
+## TNs
+### Get TN
+```ruby
+tn = Bandwidth::Tn.get(fullNumber)
+```
+### List TNs
+```ruby
+Bandwidth::Tn.list(query)
+```
+### TN Instance Methods
+```ruby
+# Get TN Details
+tn = tn.geti_tn_details()
+
+# Get Sites
+tn.get_sites()
+
+# Get Sip Peers
+tn.get_sip_peers()
+
+# Get Rate Center
+tn.get_rate_center()
+
+```
+
+## TN Reservation
+### Create TN Reservation
+```ruby
+Bandwidth::TnReservation.create({:reserved_tn => "9195551212"})
+```
+### Get TN Reservation
+```ruby
+tn = Bandwidth::TnReservation.get(id)
+```
+### Delete TN Reservation
+```ruby
+tn.delete()
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/examples/account.rb

@@ -0,0 +1,15 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'yaml'
+require 'ruby-bandwidth-iris'
+config = YAML.load_file('config.yml')
+
+BandwidthIris::Client.global_options = {
+  :api_endpoint => config['api_endpoint'],
+  :user_name => config['user_name'],
+  :password => config['password'],
+  :account_id => config['account_id']
+}
+puts BandwidthIris::Account.get()
+

data/examples/available_npa_nxx.rb

@@ -0,0 +1,17 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'yaml'
+require 'ruby-bandwidth-iris'
+config = YAML.load_file('config.yml')
+
+BandwidthIris::Client.global_options = {
+  :api_endpoint => config['api_endpoint'],
+  :user_name => config['user_name'],
+  :password => config['password'],
+  :account_id => config['account_id']
+}
+
+
+puts BandwidthIris::AvailableNpaNxx.list({:state => 'NC', :quantity => 3})
+

data/examples/available_number.rb

@@ -0,0 +1,17 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'yaml'
+require 'ruby-bandwidth-iris'
+config = YAML.load_file('config.yml')
+
+BandwidthIris::Client.global_options = {
+  :api_endpoint => config['api_endpoint'],
+  :user_name => config['user_name'],
+  :password => config['password'],
+  :account_id => config['account_id']
+}
+
+
+puts BandwidthIris::AvailableNumber.list({:state => "NC", :quantity => 3})
+