ruby-bandwidth-iris 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6eb0be263ea4f9801165248f8c578e6d85205ef4494711204d587979a8f0bd1
-  data.tar.gz: 96e2af6369e6a319e3be929ace9181a49e488ea98bda0491093285d8895b4416
+  metadata.gz: f77d77b3e9fd1b459cab7159cff5f35ec0d4dcb00186e70d54106382c3156d20
+  data.tar.gz: d08b335e9133e43b37bc5d79381eda44fc9aed4cca7e91905887d9e5e1b2282e
 SHA512:
-  metadata.gz: 5728361fdb4eab48bb47928514a32b3dec2d4c38bab3103e4d273ea0a9b429ad0a25eaee5eed4d695f54891987cde64f1dd45c91fea78233d6f9764e5437793d
-  data.tar.gz: 855ef5ba77813675956787b8511dae06f5ed25c72015661a4d52ac6bba612d098758519b54848124a425301fdecde927a0cf8082607fe1feb26dbd7ce05f272d
+  metadata.gz: c359fa2a8b0a422f13262cefb9006d2e236728bda17d91184f50c8ec63b4c3f44348cadbd954987997ffc3dccc3670abf120997acc7c7cfb8350f794ef9b0a74
+  data.tar.gz: 4ec6c1230937b62513f1950652b11906b2090265a2ea97a1a38f737fe166d411ea0943b93fe24770adec385e3bc35e3cc2415d573c61c5acd40c5920901a8cbf

data/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Global rule:
+* @Bandwidth/dx

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,40 @@
+---
+name: Bug Report
+about: Create a bug report.
+title: '[BUG] Description'
+labels: 'bug'
+---
+
+### Checklist
+ - [ ] Have you provided a description of the bug?
+ - [ ] Have you provided your Environment information?
+ - [ ] Have you provided a sample code snippet?
+ - [ ] Have you provided a stack trace?
+ - [ ] Have you outlined the expected behavior?
+
+### Description
+<!-- Please provide a clear and concise description of the bug. -->
+
+### Environment Information
+<!-- Please provide the version of the OS, SDK, and Environment you are experiencing the bug in. -->
+ - OS Version: _(e.g. Windows 10)_
+ - SDK Version: _(e.g. 1.1.0)_
+ - Environment: _(e.g. Ruby 3.1.0)_
+
+### Sample Code Snippet
+<!-- Please provide a code snippet that produces or is relevant to the bug. -->
+```ruby
+# Sample Code Snippet
+```
+
+### Stack Trace
+<!-- Please provide the stack trace that shows the bug. -->
+```shell
+# Stack Trace
+```
+
+### Expected Behavior
+<!-- Please outline the expected behavior of the SDK. -->
+
+### Suggested Fix
+<!-- If you have a fix or a suggestion for how this bug may be resolved, describe it here. -->

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Bandwidth Support
+    url: https://www.bandwidth.com/support/
+    about: Current customers can create tickets for our Support Team here.

data/.github/workflows/deploy.yml

@@ -0,0 +1,42 @@
+name: Deploy SDK
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  deploy:
+    name: Deploy to Rubygems
+    if: ${{ !github.event.release.prerelease && github.event.release.target_commitish == 'master' }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+
+    - name: Install Packages
+      run: bundle install
+
+    - name: Test
+      run: rake
+
+    - name: Deploy to Rubygems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+
+    - uses: Bandwidth/build-notify-slack-action@v1.0.0
+      if: always()
+      with:
+        job-status: ${{ job.status }}
+        slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+        slack-channel: ${{ secrets.SLACK_CHANNEL }}

data/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on:
+  schedule:
+    - cron: "0 4 * * *"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix: 
+        os: [windows-2022, windows-2019, ubuntu-18.04, ubuntu-20.04]
+        ruby-version: [2.6, 2.7, 3.0]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+    
+    - name: Install Packages
+      run: bundle install
+
+    - name: Test
+      run: rake
+
+    - name: Notify Slack of Failures    
+      uses: Bandwidth/build-notify-slack-action@v1.0.0
+      if: failure() && !github.event.pull_request.draft
+      with:
+        job-status: ${{ job.status }}
+        slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
+        slack-channel: ${{ secrets.SLACK_CHANNEL }}

data/Gemfile

@@ -5,3 +5,5 @@ group :test do
   gem 'rspec', '3.9.0'
   gem 'simplecov', '~> 0.16.1'
 end
+
+gemspec

data/README.md

@@ -22,6 +22,7 @@ Ruby Client library for IRIS / BBS API
 | 3.0.0 | Removed functionality that causes an error to be raised when some type of `error` field is returned in the XML body response. This change reduces the situations that cause an error to be thrown to simply be 4XX and 5XX http responses. This change was made to improve communication when an error is found. Please update your code to handle this change. |
 | 3.0.2 | Fixed an incorrect retrieval of DLDA objects |
 | 4.0.0 | Removed certify gem. Users will now need to set their own SSL settings |
+| 4.1.0 | Added support for SIP credentials.
 
 ### 3.x.x release
 

data/examples/account.rb

@@ -11,5 +11,10 @@ BandwidthIris::Client.global_options = {
   :password => config['password'],
   :account_id => config['account_id']
 }
-puts BandwidthIris::Account.get()
+
+begin
+  puts BandwidthIris::Account.get()
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end
 

data/examples/available_npa_nxx.rb

@@ -13,5 +13,9 @@ BandwidthIris::Client.global_options = {
 }
 
 
-puts BandwidthIris::AvailableNpaNxx.list({:state => 'NC', :quantity => 3})
+begin
+  puts BandwidthIris::AvailableNpaNxx.list({:state => 'NC', :quantity => 3})
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end
 

data/examples/available_number.rb

@@ -13,5 +13,9 @@ BandwidthIris::Client.global_options = {
 }
 
 
-puts BandwidthIris::AvailableNumber.list({:state => "NC", :quantity => 3})
+begin
+  puts BandwidthIris::AvailableNumber.list({:state => "NC", :quantity => 3})
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end
 

data/examples/available_number_details.rb

@@ -12,4 +12,8 @@ BandwidthIris::Client.global_options = {
   :account_id => config['account_id']
 }
 
-puts BandwidthIris::AvailableNumber.list({:state => "NC", :quantity => 3, :enable_t_n_detail => true})
+begin
+  puts BandwidthIris::AvailableNumber.list({:state => "NC", :quantity => 3, :enable_t_n_detail => true})
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end

data/examples/city.rb

@@ -12,5 +12,9 @@ BandwidthIris::Client.global_options = {
   :account_id => config['account_id']
 }
 
-puts BandwidthIris::City.list({:available => true, :state => 'NC'})
+begin
+  puts BandwidthIris::City.list({:available => true, :state => 'NC'})
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end
 

data/examples/config.yml.example

@@ -1,4 +1,4 @@
-api_endpoint: "https://api.inetwork.com"
+api_endpoint: "https://dashboard.bandwidth.com"
 account_id: ""
 user_name: ""
 password: ""

data/examples/covered-rate-center.rb

@@ -12,8 +12,11 @@ BandwidthIris::Client.global_options = {
   :account_id => config['account_id']
 }
 
-
-BandwidthIris::CoveredRateCenter.list({:zip => '27609', :page=>1, :size=>100}).each do |c|
-  puts c.to_data
+begin
+  BandwidthIris::CoveredRateCenter.list({:zip => '27609', :page=>1, :size=>100}).each do |c|
+    puts c.to_data
+  end
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
 end
 

data/examples/order.rb

@@ -14,35 +14,39 @@ BandwidthIris::Client.global_options = {
 
 number = '9195551212' #exisitng number for order
 
+begin
+  site = BandwidthIris::Site.create({
+    :name => "Ruby Test Site",
+    :description => "A Site From Ruby SDK Examples",
+    :address => {
+      :house_number => "123",
+      :street_name => "Anywhere St",
+      :city => "Raleigh",
+      :state_code =>"NC",
+      :zip => "27609",
+      :address_type => "Service"
+    }
+  })
+
+  order =  BandwidthIris::Order.create({
+    :name =>"A Test Order",
+    :site_id => site.id,
+    :existing_telephone_number_order_type => {
+      :telephone_number_list =>
+        {
+          :telephone_number => [number]
+        }
+
+    }
+  })
+
+  puts order.to_data
+
+  order = BandwidthIris::Order.get(order.id)
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end
 
-site = BandwidthIris::Site.create({
-  :name => "Ruby Test Site",
-  :description => "A Site From Ruby SDK Examples",
-  :address => {
-    :house_number => "123",
-    :street_name => "Anywhere St",
-    :city => "Raleigh",
-    :state_code =>"NC",
-    :zip => "27609",
-    :address_type => "Service"
-  }
-})
-
-order =  BandwidthIris::Order.create({
-  :name =>"A Test Order",
-  :site_id => site.id,
-  :existing_telephone_number_order_type => {
-    :telephone_number_list =>
-      {
-        :telephone_number => [number]
-      }
-
-  }
-})
-
-puts order.to_data
-
-order = BandwidthIris::Order.get(order.id)
 
 puts order.to_data
 

data/examples/port-in.rb

@@ -16,58 +16,62 @@ number_to_check = '+12525130283' #TODO fill with valid number
 
 host = '1.1.2.3'
 
+begin
+  site = BandwidthIris::Site.create({
+    :name => "Ruby Test Site",
+    :description => "A Site From Ruby SDK Examples",
+    :address => {
+      :house_number => "123",
+      :street_name => "Anywhere St",
+      :city => "Raleigh",
+      :state_code =>"NC",
+      :zip => "27609",
+      :address_type => "Service"
+    }
+  })
 
-site = BandwidthIris::Site.create({
-  :name => "Ruby Test Site",
-  :description => "A Site From Ruby SDK Examples",
-  :address => {
-    :house_number => "123",
-    :street_name => "Anywhere St",
-    :city => "Raleigh",
-    :state_code =>"NC",
-    :zip => "27609",
-    :address_type => "Service"
-  }
-})
-
-data = {
-  :peer_name => "A New SIP Peer",
-  :is_default_peer => true,
-  :short_messaging_protocol => "SMPP",
-  :site_id => site[:id],
-  :voice_hosts =>
-  {
-      :host => {
-        :host_name => host
-      }
-  },
-  :sms_hosts =>
-  {
-      :host => {
-        :host_name => host
-      }
-  },
-  :termination_hosts =>
+  data = {
+    :peer_name => "A New SIP Peer",
+    :is_default_peer => true,
+    :short_messaging_protocol => "SMPP",
+    :site_id => site[:id],
+    :voice_hosts =>
     {
-      :termination_host => {
-        :host_name => host,
-        :port => 5060,
+        :host => {
+          :host_name => host
+        }
+    },
+    :sms_hosts =>
+    {
+        :host => {
+          :host_name => host
+        }
+    },
+    :termination_hosts =>
+      {
+        :termination_host => {
+          :host_name => host,
+          :port => 5060,
+        }
       }
-    }
 
-}
+  }
 
-sip_peer = BandwidthIris::SipPeer.create(site[:id], data)
+  sip_peer = BandwidthIris::SipPeer.create(site[:id], data)
 
-res = BandwidthIris::LnpChecker.check(number_to_check)
+  res = BandwidthIris::LnpChecker.check(number_to_check)
 
-if res[:portable_numbers] && res[:portable_numbers][:tn] == number_to_check
-  puts 'Your number is portable. Creating PortIn Order'
-  port_in = BandwidthIris::PortIn.create(create_port_in_order(number_to_check, site, sip_peer))
-  puts "Created order #{port_in[:id]}"
-  port_in.create_file(File.open('./loa.pdf', 'r'), 'application/pdf')
+  if res[:portable_numbers] && res[:portable_numbers][:tn] == number_to_check
+    puts 'Your number is portable. Creating PortIn Order'
+    port_in = BandwidthIris::PortIn.create(create_port_in_order(number_to_check, site, sip_peer))
+    puts "Created order #{port_in[:id]}"
+    port_in.create_file(File.open('./loa.pdf', 'r'), 'application/pdf')
+  end
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
 end
 
+
 def create_port_in_order(number, site, sip_peer)
    {
     :site_id => site[:id],

data/examples/sip_peer.rb

@@ -14,47 +14,51 @@ BandwidthIris::Client.global_options = {
 
 host = '10.20.30.41'
 
+begin
+  site = BandwidthIris::Site.create({
+    :name => "Ruby Test Site",
+    :description => "A Site From Ruby SDK Examples",
+    :address => {
+      :house_number => "123",
+      :street_name => "Anywhere St",
+      :city => "Raleigh",
+      :state_code =>"NC",
+      :zip => "27609",
+      :address_type => "Service"
+    }
+  })
 
-site = BandwidthIris::Site.create({
-  :name => "Ruby Test Site",
-  :description => "A Site From Ruby SDK Examples",
-  :address => {
-    :house_number => "123",
-    :street_name => "Anywhere St",
-    :city => "Raleigh",
-    :state_code =>"NC",
-    :zip => "27609",
-    :address_type => "Service"
-  }
-})
-
-data = {
-  :peer_name => "A New SIP Peer",
-  :is_default_peer => true,
-  :short_messaging_protocol => "SMPP",
-  :site_id => site[:id],
-  :voice_hosts =>
-  {
-      :host => {
-        :host_name => host
-      }
-  },
-  :sms_hosts =>
-  {
-      :host => {
-        :host_name => host
-      }
-  },
-  :termination_hosts =>
+  data = {
+    :peer_name => "A New SIP Peer",
+    :is_default_peer => true,
+    :short_messaging_protocol => "SMPP",
+    :site_id => site[:id],
+    :voice_hosts =>
+    {
+        :host => {
+          :host_name => host
+        }
+    },
+    :sms_hosts =>
     {
-      :termination_host => {
-        :host_name => host,
-        :port => 5060,
+        :host => {
+          :host_name => host
+        }
+    },
+    :termination_hosts =>
+      {
+        :termination_host => {
+          :host_name => host,
+          :port => 5060,
+        }
       }
-    }
 
-}
-sip_peer = BandwidthIris::SipPeer.create(site[:id], data)
+  }
+  sip_peer = BandwidthIris::SipPeer.create(site[:id], data)
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end
+
 
 
 sip_peer.delete(site[:id])

data/examples/site.rb

@@ -12,18 +12,21 @@ BandwidthIris::Client.global_options = {
   :account_id => config['account_id']
 }
 
-
-site = BandwidthIris::Site.create({
-  :name => "Ruby Test Sitei1",
-  :description => "A Site From Ruby SDK Examples",
-  :address => {
-    :house_number => "123",
-    :street_name => "Anywhere St",
-    :city => "Raleigh",
-    :state_code =>"NC",
-    :zip => "27609",
-    :address_type => "Service"
-  }
-})
+begin
+  site = BandwidthIris::Site.create({
+    :name => "Ruby Test Sitei1",
+    :description => "A Site From Ruby SDK Examples",
+    :address => {
+      :house_number => "123",
+      :street_name => "Anywhere St",
+      :city => "Raleigh",
+      :state_code =>"NC",
+      :zip => "27609",
+      :address_type => "Service"
+    }
+  })
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
+end
 
 site.delete()

data/examples/tn.rb

@@ -13,8 +13,11 @@ BandwidthIris::Client.global_options = {
   :account_id => config['account_id']
 }
 
-list = BandwidthIris::Tn.list({:npa => '818', :page => 1, :size => 100}).each do |n|
-  puts n.to_data
+begin
+  list = BandwidthIris::Tn.list({:npa => '818', :page => 1, :size => 100}).each do |n|
+    puts n.to_data
+  end
+  puts BandwidthIris::Tn.get(list[0][:full_number]).to_data
+rescue BandwidthIris::Errors::GenericError => e
+  puts e.message
 end
-
-puts BandwidthIris::Tn.get(list[0][:full_number]).to_data

data/lib/bandwidth-iris/client.rb

@@ -1,5 +1,6 @@
 require 'faraday'
 require 'faraday_middleware'
+require 'active_support'
 require 'active_support/xml_mini'
 require 'active_support/core_ext/hash/conversions'
 require 'active_support/core_ext/string/inflections'
@@ -28,7 +29,7 @@ module BandwidthIris
       @set_adapter = lambda {|faraday| faraday.adapter(Faraday.default_adapter)}
       @create_connection = lambda{||
         Faraday.new(api_endpoint) { |faraday|
-          faraday.basic_auth(user_name, password)
+          faraday.request :basic_auth, user_name, password
           #faraday.response :logger
           faraday.headers['Accept'] = 'application/xml'
           faraday.headers['user-agent'] = 'Ruby-Bandwidth-Iris'
@@ -119,7 +120,7 @@ module BandwidthIris
     # @param response response object
     def check_response(response)
       parsed_body = parse_xml(response.body || '')
-      raise Errors::GenericError.new('', "Http code #{response.status}", response.status) if response.status >= 400
+      raise Errors::GenericError.new(response.status, response.reason_phrase, response.headers, parsed_body) if response.status >= 400
       parsed_body
     end
 

data/lib/bandwidth-iris/dlda.rb

@@ -18,7 +18,7 @@ module BandwidthIris
 
     def self.get(client, id)
       data  = client.make_request(:get, "#{client.concat_account_path(DLDA_PATH)}/#{id}")[0]
-      data[:id] = data[:order_id]
+      data[:id] = data[:dlda_order][:order_id]
       Dlda.new(data, client)
     end
     wrap_client_arg :get

data/lib/bandwidth-iris/errors.rb

@@ -2,17 +2,29 @@ module BandwidthIris
   module Errors
     # Generic error class
     class GenericError < StandardError
-      # @return [String] Error code
-      attr_reader :code
-
-      # @return [String] Http status code
+      # @return [String] HTTP status code
       attr_reader :http_status
 
+      # return [String] Reason
+      attr_reader :reason
+
+      # return [Hash] Headers
+      attr_reader :headers
+
+      # return [Hash] Body
+      attr_reader :body
+
+      # @return [String] Iris Error code
+      attr_reader :code
+
       # @api private
-      def initialize code, message, http_status
-        super message
-        @code = code
+      def initialize http_status, reason, headers, body
         @http_status = http_status
+        @reason = reason
+        @headers = headers
+        @body = body
+        @code = body.nil? ? '' : body[:error][:code]
+        super message = "HTTP Error\nStatus Code: #{@http_status}\nReason: #{@reason}\nHTTP Headers: #{@headers}\nResponse Body: #{@body}\nIris Error Code: #{@code}"
       end
     end
 

data/lib/bandwidth-iris/in_service_number.rb

@@ -11,7 +11,7 @@ module BandwidthIris
     wrap_client_arg :list
 
     def self.get(client, number)
-      client.make_request(:get, "#{client.concat_account_path(INSERVICE_NUMBER_PATH)}/#{URI.escape(number)}")[0]
+      client.make_request(:get, "#{client.concat_account_path(INSERVICE_NUMBER_PATH)}/#{CGI.escape(number)}")[0]
     end
     wrap_client_arg :get
 

data/lib/bandwidth-iris/port_in.rb

@@ -64,12 +64,12 @@ module BandwidthIris
     end
 
     def get_file_metadata(file_name)
-      @client.make_request(:get, "#{@client.concat_account_path(PORT_IN_PATH)}/#{id}/#{LOAS_PATH}/#{URI.encode(file_name)}/metadata")[0]
+      @client.make_request(:get, "#{@client.concat_account_path(PORT_IN_PATH)}/#{id}/#{LOAS_PATH}/#{CGI.escape(file_name)}/metadata")[0]
     end
 
     def get_file(file_name)
       connection = @client.create_connection()
-      response = connection.get("/#{@client.api_version}#{@client.concat_account_path(PORT_IN_PATH)}/#{id}/#{LOAS_PATH}/#{URI.encode(file_name)}")
+      response = connection.get("/#{@client.api_version}#{@client.concat_account_path(PORT_IN_PATH)}/#{id}/#{LOAS_PATH}/#{CGI.escape(file_name)}")
       [response.body, response.headers['Content-Type'] || 'application/octet-stream']
     end
 

data/lib/bandwidth-iris/sip_credential.rb

@@ -0,0 +1,42 @@
+module BandwidthIris
+  SIP_CREDENTIAL_PATH = 'sipcredentials'
+
+  class SipCredential
+    extend ClientWrapper
+    include ApiItem
+
+    def self.list(client, query = nil)
+      list = client.make_request(:get, client.concat_account_path(SIP_CREDENTIAL_PATH), query)[0][:sip_credential]
+      list = if list.is_a?(Array) then list else [list] end
+      list.map do |i|
+        SipCredential.new(i, client)
+      end
+    end
+    wrap_client_arg :list
+
+    def self.get(client, id)
+      data = client.make_request(:get, "#{client.concat_account_path(SIP_CREDENTIAL_PATH)}/#{id}")[0]
+      SipCredential.new(data[:sip_credential], client)
+    end
+    wrap_client_arg :get
+
+    def self.create(client, item)
+      data = client.make_request(
+        :post,
+        client.concat_account_path(SIP_CREDENTIAL_PATH),
+        { :sip_credentials => { :sip_credential => item } }
+      )[0][:valid_sip_credentials]
+      SipCredential.new(data[:sip_credential], client)
+    end
+    wrap_client_arg :create
+
+
+    def update(data)
+      @client.make_request(:put,"#{@client.concat_account_path(SIP_CREDENTIAL_PATH)}/#{user_name}", {:sip_credential => data})
+    end
+
+    def delete
+      @client.make_request(:delete,"#{@client.concat_account_path(SIP_CREDENTIAL_PATH)}/#{user_name}")
+    end
+  end
+end

data/lib/bandwidth-iris/sip_peer.rb

@@ -26,7 +26,7 @@ module BandwidthIris
 
 
     def get_tns(number = nil)
-      r = @client.make_request(:get,"#{@client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{id}/tns#{if number then '/' + URI.escape(number) else '' end}")[0]
+      r = @client.make_request(:get,"#{@client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{id}/tns#{if number then '/' + CGI.escape(number) else '' end}")[0]
       if number
         r[:sip_peer_telephone_number]
       else
@@ -37,7 +37,7 @@ module BandwidthIris
     end
 
     def update_tns(number, data)
-      @client.make_request(:put,"#{@client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{id}/tns/#{URI.escape(number)}", {:sip_peer_telephone_number => data})[0]
+      @client.make_request(:put,"#{@client.concat_account_path(SITE_PATH)}/#{site_id}/#{SIPPEER_PATH}/#{id}/tns/#{CGI.escape(number)}", {:sip_peer_telephone_number => data})[0]
     end
 
     def move_tns(numbers)

data/lib/bandwidth-iris/tn.rb

@@ -6,7 +6,7 @@ module BandwidthIris
     include ApiItem
 
     def self.get(client, number)
-      data  = client.make_request(:get, "#{TN_PATH}/#{URI.escape(number)}")[0]
+      data  = client.make_request(:get, "#{TN_PATH}/#{CGI.escape(number)}")[0]
       Tn.new(data, client)
     end
     wrap_client_arg :get
@@ -23,19 +23,19 @@ module BandwidthIris
     wrap_client_arg :list
 
     def get_sites()
-      @client.make_request(:get, "#{TN_PATH}/#{URI.escape(telephone_number)}/sites")[0]
+      @client.make_request(:get, "#{TN_PATH}/#{CGI.escape(telephone_number)}/sites")[0]
     end
 
     def get_sip_peers()
-      @client.make_request(:get, "#{TN_PATH}/#{URI.escape(telephone_number)}/sippeers")[0]
+      @client.make_request(:get, "#{TN_PATH}/#{CGI.escape(telephone_number)}/sippeers")[0]
     end
 
     def get_rate_center()
-      @client.make_request(:get, "#{TN_PATH}/#{URI.escape(telephone_number)}/ratecenter")[0][:telephone_number_details]
+      @client.make_request(:get, "#{TN_PATH}/#{CGI.escape(telephone_number)}/ratecenter")[0][:telephone_number_details]
     end
 
     def get_details()
-      @client.make_request(:get, "#{TN_PATH}/#{URI.escape(telephone_number)}/tndetails")[0][:telephone_number_details]
+      @client.make_request(:get, "#{TN_PATH}/#{CGI.escape(telephone_number)}/tndetails")[0][:telephone_number_details]
     end
   end
 end

data/lib/bandwidth-iris/version.rb

@@ -1,4 +1,4 @@
 module BandwidthIris
   # Version of this gem
-  VERSION = "4.0.0"
+  VERSION = "5.0.0"
 end

data/lib/ruby-bandwidth-iris.rb

@@ -20,6 +20,7 @@ require 'bandwidth-iris/order'
 require 'bandwidth-iris/port_in'
 require 'bandwidth-iris/port_out'
 require 'bandwidth-iris/rate_center'
+require 'bandwidth-iris/sip_credential'
 require 'bandwidth-iris/sip_peer'
 require 'bandwidth-iris/site'
 require 'bandwidth-iris/subscription'

data/ruby-bandwidth-iris.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware"
   spec.add_dependency "nori"
   spec.add_dependency "activesupport",">= 4.2.7"
+  spec.add_dependency "rexml"
 
   spec.add_development_dependency "bundler", ">= 1.3"
   spec.add_development_dependency "rake", ">= 11.1.0"

data/spec/bandwidth-iris/client_spec.rb

@@ -46,7 +46,6 @@ describe BandwidthIris::Client do
     it 'should create new faraday connection' do
       connection = client.create_connection()
       expect(connection).to be_a(Faraday::Connection)
-      expect(connection.headers['Authorization']).to eql("Basic #{Base64.strict_encode64('username:password')}")
     end
   end
 
@@ -60,6 +59,12 @@ describe BandwidthIris::Client do
       client.stubs.verify_stubbed_calls()
     end
 
+    it 'should pass basic auth headers' do
+      # Note: This endpoint does not exist. It is stubbed in order to echo back the Authorization headers that are added by Faraday middleware.
+      client.stubs.get('/v1.0/test-auth') { |env| [200, {}, "<Result><EchoedAuth>#{env[:request_headers]['Authorization']}</EchoedAuth></Result>"] }
+      expect(client.make_request(:get, '/test-auth')).to eql([{:echoed_auth=>"Basic #{Base64.strict_encode64('username:password')}"}, {}])
+    end
+
     it 'should make GET request and return xml  data' do
       client.stubs.get('/v1.0/path1') { |env| [200, {}, '<Result><Test>data</Test></Result>'] }
       client.stubs.get('/v1.0/path2?testField=10') { |env| [200, {'Location'=>'url'}, '<Root><TestValue>10</TestValue><DataArray>1</DataArray><DataArray>2</DataArray><BoolValue>true</BoolValue><BoolValue2>false</BoolValue2><DateTimeValue>2015-05-29T01:02:03Z</DateTimeValue></Root>'] }
@@ -83,8 +88,13 @@ describe BandwidthIris::Client do
     end
 
     it 'should raise error if http status >= 400' do
-      client.stubs.get('/v1.0/path1') { |env| [400, {}, ''] }
-      expect{client.make_request(:get, '/path1')}.to raise_error(Errors::GenericError, "Http code 400")
+      client.stubs.get('/v1.0/path1') { |env| [400, {'content-type'=>'application/xml'}, '<SearchResult><Error><Code>4010</Code><Description>The state abbreviation N is not valid.</Description></Error></SearchResult>'] }
+      expect{client.make_request(:get, '/path1')}.to raise_error(an_instance_of(Errors::GenericError).and having_attributes({
+        http_status: 400,
+        headers: {"content-type"=>"application/xml"},
+        code: 4010,
+        body: {:error=>{:code=>4010, :description=>"The state abbreviation N is not valid."}}
+      }))
     end
   end
 end

data/spec/bandwidth-iris/sipcredential_spec.rb

@@ -0,0 +1,54 @@
+describe BandwidthIris::SipCredential do
+  client = nil
+
+  before :each do
+    client = Helper.get_client()
+  end
+
+  after :each do
+    client.stubs.verify_stubbed_calls()
+  end
+
+  describe '#list' do
+    it 'should return sip credentials' do
+      client.stubs.get('/v1.0/accounts/accountId/sipcredentials') {|env| [200, {}, Helper.xml['sip_credentials']]}
+      list = SipCredential.list(client)
+      expect(list.length).to eql(1)
+      expect(list[0][:user_name]).to eql(1)
+    end
+  end
+
+  describe '#get' do
+    it 'should return a sip credential' do
+      client.stubs.get('/v1.0/accounts/accountId/sipcredentials/1') {|env| [200, {}, Helper.xml['sip_credentials']]}
+      item = SipCredential.get(client, 1)
+      expect(item[:user_name]).to eql(1)
+    end
+  end
+
+  describe '#create' do
+    it 'should create a sip credential' do
+      data = {:name => "test", :description => "test"}
+      client.stubs.post('/v1.0/accounts/accountId/sipcredentials', client.build_xml({:sip_credentials => { sip_credential: data }})) {|env| [200, {}, Helper.xml['valid_sip_credentials']]}
+      item = SipCredential.create(client, data)
+      expect(item[:user_name]).to eql(1)
+    end
+  end
+
+  describe '#update' do
+    it 'should update a sip credential' do
+      data = {:hash1 => "1g32gadgs433dd4"}
+      client.stubs.put('/v1.0/accounts/accountId/sipcredentials/1', client.build_xml({:sip_credential => data})) {|env| [200, {}, '']}
+      item = SipCredential.new({:user_name => 1}, client)
+      item.update(data)
+    end
+  end
+
+  describe '#delete' do
+    it 'should remove a sip credential' do
+      client.stubs.delete('/v1.0/accounts/accountId/sipcredentials/1') {|env| [200, {}, '']}
+      item = SipCredential.new({:user_name => 1}, client)
+      item.delete
+    end
+  end
+end

data/spec/helper.rb

@@ -2,10 +2,10 @@ require 'simplecov'
 require 'coveralls'
 require 'yaml'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter::new
+SimpleCov::Formatter::HTMLFormatter
+Coveralls::SimpleCov::Formatter
+
 SimpleCov.start()
 
 require 'ruby-bandwidth-iris'

data/spec/xml.yml

@@ -1,6 +1,8 @@
 ---
   sites: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><SitesResponse><Sites><Site><Id>1</Id><Name>Test Site</Name><Description>A site description</Description></Site></Sites></SitesResponse>"
   site: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><SiteResponse><Site><Id>1</Id><Name>Test Site</Name><Description>A Site Description</Description><Address><HouseNumber>900</HouseNumber><StreetName>Main Campus Drive</StreetName><City>Raleigh</City><StateCode>NC</StateCode><Zip>27615</Zip><Country>United States</Country><AddressType>Service</AddressType></Address></Site></SiteResponse>"
+  sip_credentials: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><SipCredentialsResponse><SipCredential><UserName>1</UserName></SipCredential></SipCredentialsResponse>"
+  valid_sip_credentials: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><SipCredentialsResponse><ValidSipCredentials><SipCredential><UserName>1</UserName></SipCredential></ValidSipCredentials></SipCredentialsResponse>"
   sip_peers: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><TNSipPeersResponse><SipPeers><SipPeer xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"SipPeer\"><PeerId>12345</PeerId><PeerName>SIP Peer 1</PeerName><Description>Sip Peer 1 description</Description><IsDefaultPeer>true</IsDefaultPeer><ShortMessagingProtocol>SIP</ShortMessagingProtocol><VoiceHosts><Host><HostName>70.62.112.156</HostName></Host></VoiceHosts><VoiceHostGroups/><SmsHosts><Host><HostName>70.62.112.156</HostName></Host></SmsHosts><TerminationHosts><TerminationHost><HostName>70.62.112.156</HostName><Port>5060</Port><CustomerTrafficAllowed>DOMESTIC</CustomerTrafficAllowed><DataAllowed>true</DataAllowed></TerminationHost></TerminationHosts><CallingName><Display>true</Display><Enforced>false</Enforced></CallingName></SipPeer></SipPeers></TNSipPeersResponse>"
   sip_peer: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><SipPeerResponse><SipPeer><PeerId>10</PeerId><PeerName>SIP Peer 1</PeerName><Description>Sip Peer 1 description</Description><IsDefaultPeer>true</IsDefaultPeer><ShortMessagingProtocol>SIP</ShortMessagingProtocol><VoiceHosts/><VoiceHostGroups/><SmsHosts/><TerminationHosts/><CallingName><Display>true</Display><Enforced>false</Enforced></CallingName></SipPeer></SipPeerResponse>"
   sip_peer_tns: "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><SipPeerTelephoneNumbersResponse><SipPeerTelephoneNumbers><SipPeerTelephoneNumber><FullNumber>3034162216</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3034162218</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3034162227</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>7025097265</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3034162212</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>7024759964</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3034162226</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3034162231</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3034162223</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>2143770078</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3302699968</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>8665711365</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>9284448929</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>3302710174</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>7024797571</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>7025091999</FullNumber></SipPeerTelephoneNumber><SipPeerTelephoneNumber><FullNumber>7022579119</FullNumber></SipPeerTelephoneNumber></SipPeerTelephoneNumbers></SipPeerTelephoneNumbersResponse>"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-bandwidth-iris
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Andrey Belchikov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-15 00:00:00.000000000 Z
+date: 2022-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.7
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,12 +137,17 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Gem for integrating to Bandwidth's Iris API
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/CODEOWNERS"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/workflows/deploy.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -181,6 +200,7 @@ files:
 - lib/bandwidth-iris/port_out.rb
 - lib/bandwidth-iris/rate_center.rb
 - lib/bandwidth-iris/remove_imported_tn_orders.rb
+- lib/bandwidth-iris/sip_credential.rb
 - lib/bandwidth-iris/sip_peer.rb
 - lib/bandwidth-iris/sip_peer_products.rb
 - lib/bandwidth-iris/site.rb
@@ -221,6 +241,7 @@ files:
 - spec/bandwidth-iris/remove_imported_tn_orders_spec.rb
 - spec/bandwidth-iris/sip_peer_products_spec.rb
 - spec/bandwidth-iris/sip_peer_spec.rb
+- spec/bandwidth-iris/sipcredential_spec.rb
 - spec/bandwidth-iris/site_spec.rb
 - spec/bandwidth-iris/subscription_spec.rb
 - spec/bandwidth-iris/tn_options_spec.rb
@@ -233,7 +254,7 @@ homepage: https://github.com/bandwidthcom/ruby-bandwidth-iris
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -248,8 +269,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: Gem for integrating to Bandwidth's Iris API
 test_files:
@@ -282,6 +303,7 @@ test_files:
 - spec/bandwidth-iris/remove_imported_tn_orders_spec.rb
 - spec/bandwidth-iris/sip_peer_products_spec.rb
 - spec/bandwidth-iris/sip_peer_spec.rb
+- spec/bandwidth-iris/sipcredential_spec.rb
 - spec/bandwidth-iris/site_spec.rb
 - spec/bandwidth-iris/subscription_spec.rb
 - spec/bandwidth-iris/tn_options_spec.rb