ruby-bandwidth-iris 2.7.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14a99ba0cef144d31f4fd049ccac5dd693d203ac362142530b77b2bd0ea7f880
-  data.tar.gz: af1a0f0090c789bcda82fab2ec87d71469229ca17eb5bd0b519a2721d4e425ad
+  metadata.gz: 3f848141460dbc00663529dd048bdb76e1a8e26860c18ece42b62e607ad97330
+  data.tar.gz: 9d7cd88f53989bc55a452eb1a14654cf4887dddc81263aaadb6da1aaaf9e3b1d
 SHA512:
-  metadata.gz: 4a27c0764fb56d578b5366dff2d34ca2ba067212d7a954dfb59f487df22c62a8eedb909b5364c74ef09ac589db5e0b43fde2045830cee86b6ea14d10657ee117
-  data.tar.gz: 4d17e5b5687f40cd2aecb138e0cac0f08e805b363e29c719bde3f7ae9ee14ef9f5347437fe8a1d37e29cea828bfe2971d59b0e06308d84da1574c8f0f557cdbc
+  metadata.gz: 9b9a1d38bda953a82a7513bb6160c6689a2bdd893d7c04175c52c09da8baca93a8b28aa74c9541246e74e2ee212ae46cdcb8dafe936188d5baac9c7f9c7735cf
+  data.tar.gz: c5b16c0e5407e8f3efb7c20a87503b27fbb36b27fe68fc1cd6d7678a4614ff42cb28b8b0eca6414c974d581b9f17f1479c8a8eea336378f01be97650666f8c23

data/README.md

@@ -6,18 +6,45 @@ Ruby Client library for IRIS / BBS API
 
 ## Release Notes
 
-| Release Version | Notes                                                                                                                                                                                                                                                       |
-|:----------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| 1.0.5           | Fixed incorrect generation of XML for a Disconnect request                                                                                                                                                                                                  |
-| 2.0.0           | Added `importTnOrders`, `removeImportedTnOrders`, `inserviceNumbers`, and `importTnChecker` endpoints. This release also changed the response body of `BandwidthIris::InServiceNumber.list()`. Please make sure to update your code to include this change. |
-| 2.0.1           | Updated gem dependencies to be less restrictive                                                                                                                                                                                                             |
-| 2.1.0           | Added `csrs` endpoints                                                                                                                                                                                                                                      |
+| Release Version | Notes |
+|--|--|
+| 1.0.5 | Fixed incorrect generation of XML for a Disconnect request |
+| 2.0.0 | Added `importTnOrders`, `removeImportedTnOrders`, `inserviceNumbers`, and `importTnChecker` endpoints. This release also changed the response body of `BandwidthIris::InServiceNumber.list()`. Please make sure to update your code to include this change. |
+| 2.0.1 | Updated gem dependencies to be less restrictive |
+| 2.1.0 | Added `csrs` endpoints |
+| 2.2.0 | Added `loas` endpoints to `importTnOrders` |
 | 2.2.0           | Added `loas` endpoints to `importTnOrders`                                                                                                                                                                                                                  |
 | 2.3.0           | Added `get_tns_by_order_id` to the Orders class                                                                                                                                                                                                             |
 | 2.4.0.pre       | Added application management and sippeer products endpoints                                                                                                                                                                                                 |
 | 2.5.0           | Added `get_order_response` to pull full `<OrderResponse>` object from API, added `id` back to order object on get requests. Fixed TN Reservation and updated tests to match reality  |
 | 2.6.0 | Added Emergency Calling Notification, Emergeny Notification Group, Emergency Notification Endpoint, and Alternate End User Identity methods |
 | 2.7.0 | Added TNOptions endpoints |
+| 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 |
+
+### 3.x.x release
+
+```ruby
+failed_import_tn_order = "some_id"
+begin
+    response = BandwidthIris::ImportTnOrders.get_import_tn_order(failed_import_tn_order)
+    puts response[0]
+rescue BandwidthIris::Errors::GenericError => e
+    puts e
+end
+```
+
+#### 2.x.x result
+
+```
+Messaging route of External Third Party TNs is not configured.
+```
+
+#### 3.x.x result
+
+```
+{:customer_order_id=>"custom_id", :order_create_date=>Mon, 02 Mar 2020 20:56:48 +0000, :account_id=>123, :created_by_user=>"user", :order_id=>"0f2", :last_modified_date=>Mon, 02 Mar 2020 20:56:48 +0000, :site_id=>123, :subscriber=>{:name=>"Company INC", :service_address=>{:house_number=>123, :street_name=>"Street", :city=>"City", :state_code=>"XY", :zip=>12345, :county=>"County", :country=>"Country", :address_type=>"Service"}}, :loa_authorizing_person=>"Person", :telephone_numbers=>{:telephone_number=>"5554443333"}, :processing_status=>"FAILED", :errors=>{:error=>{:code=>19005, :description=>"Messaging route of External Third Party TNs is not configured.", :telephone_numbers=>{:telephone_number=>"5554443333"}}}, :sip_peer_id=>123}
+```
 
 ## Install
 
@@ -433,6 +460,7 @@ BandwidthIris::RateCenter.list(query)
 
 ## SIP Peers
 ### Create SIP Peer
+A Sip Peer is what is called Location in the web UI.
 ```ruby
 data = {
   :peer_name => "A New SIP Peer",
@@ -495,7 +523,7 @@ sipPeer.move_tns(numbers_to_move)
 ## Sites
 
 ### Create A Site
-A site is what is called Location in the web UI.
+A site is what is called Sub-Account in the web UI.
 ```ruby
 site = {
   :name =>"A new site",

data/lib/bandwidth-iris/client.rb

@@ -22,7 +22,7 @@ module BandwidthIris
       password = options[:password] unless password
       options[:api_endpoint] = @@global_options[:api_endpoint] unless options[:api_endpoint]
       options[:api_version] = @@global_options[:api_version] unless options[:api_version]
-      api_endpoint = options[:api_endpoint] || "https://dasbhoard.bandwidth.com"
+      api_endpoint = options[:api_endpoint] || "https://dashboard.bandwidth.com"
       api_version = options[:api_version] || "v1.0"
 
       @build_path = lambda {|path| "/#{api_version}" + (if path[0] == "/" then path else "/#{path}" end) }
@@ -120,25 +120,6 @@ module BandwidthIris
     # @param response response object
     def check_response(response)
       parsed_body = parse_xml(response.body || '')
-      code = find_first_descendant(parsed_body, :error_code)
-      description = find_first_descendant(parsed_body, :description)
-      unless code
-        error = find_first_descendant(parsed_body, :error)
-        if error
-          code = error[:code]
-          description = error[:description]
-        else
-          errors = find_first_descendant(parsed_body, :errors)
-          if errors == nil || errors.length == 0
-            code = find_first_descendant(parsed_body, :result_code)
-            description = find_first_descendant(parsed_body, :result_message)
-          else
-            errors = [errors] if errors.is_a?(Hash)
-            raise Errors::AgregateError.new(errors.map {|e| Errors::GenericError.new(e[:code], e[:description], response.status)})
-          end
-        end
-      end
-      raise Errors::GenericError.new(code, description, response.status) if code && description && code != '0' && code != 0
       raise Errors::GenericError.new('', "Http code #{response.status}", response.status) if response.status >= 400
       parsed_body
     end

data/lib/bandwidth-iris/dlda.rb

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

data/lib/bandwidth-iris/version.rb

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

data/spec/bandwidth-iris/client_spec.rb

@@ -86,41 +86,6 @@ describe BandwidthIris::Client do
       client.stubs.get('/v1.0/path1') { |env| [400, {}, ''] }
       expect{client.make_request(:get, '/path1')}.to raise_error(Errors::GenericError, "Http code 400")
     end
-
-    it 'should fail if output contains ErrorCode and Description' do
-      client.stubs.get('/v1.0/path1') { |env| [200, {}, '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Response><Test><ErrorCode>400</ErrorCode><Description>Error</Description></Test></Response>'] }
-      expect{client.make_request(:get, '/path1')}.to raise_error(Errors::GenericError, "Error")
-    end
-
-    it 'should fail if output contains element Error with Code and Description' do
-      client.stubs.get('/v1.0/path1') { |env| [200, {}, '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Response><Test><Error><Code>400</Code><Description>Error</Description></Error></Test></Response>'] }
-      expect{client.make_request(:get, '/path1')}.to raise_error(Errors::GenericError, "Error")
-    end
-
-    it 'should fail if output contains elements Errors with Code and Description' do
-      client.stubs.get('/v1.0/path1') { |env| [200, {}, '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Response><Test><Errors><Code>400</Code><Description>Error</Description></Errors><Errors><Code>401</Code><Description>Error1</Description></Errors></Test></Response>'] }
-      expect{client.make_request(:get, '/path1')}.to raise_error(Errors::AgregateError)
-    end
-
-    it 'should fail if output contains elements Errors with Code and Description (for 1 element)' do
-      client.stubs.get('/v1.0/path1') { |env| [200, {}, '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Response><Test><Errors><Code>400</Code><Description>Error</Description></Errors></Test></Response>'] }
-      expect{client.make_request(:get, '/path1')}.to raise_error(Errors::AgregateError)
-    end
-
-    it 'should fail if output contains elements resultCode and resultMessage' do
-      client.stubs.get('/v1.0/path1') { |env| [200, {}, '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Response><Test><resultCode>400</resultCode><resultMessage>Error</resultMessage></Test></Response>'] }
-      expect{client.make_request(:get, '/path1')}.to raise_error(Errors::GenericError, "Error")
-    end
-
-    it 'should fail if output contains elements resultCode and resultMessage (more deep)' do
-      client.stubs.get('/v1.0/path1') { |env| [200, {}, '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Response><Tests><Test></Test><Test><resultCode>400</resultCode><resultMessage>Error</resultMessage></Test></Tests></Response>'] }
-      expect{client.make_request(:get, '/path1')}.to raise_error(Errors::GenericError, "Error")
-    end
-
-    it 'should not fail if resultCode == 0' do
-      client.stubs.get('/v1.0/path1') { |env| [200, {}, '<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Response><Test><resultCode>0</resultCode><resultMessage>Completed</resultMessage></Test></Response>'] }
-     client.make_request(:get, '/path1')
-    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-bandwidth-iris
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Andrey Belchikov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Gem for integrating to Bandwidth's Iris API
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -247,7 +247,7 @@ homepage: https://github.com/bandwidthcom/ruby-bandwidth-iris
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -263,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Gem for integrating to Bandwidth's Iris API
 test_files: