ruby-bandwidth-iris 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b1159ee27c2a2ee423bdd0ce54a1b0943749127da435a611eeb113dec178ad0
-  data.tar.gz: a7e09992b64e938a9dc1c3943ee8be92dc9d6b8a1ed9d3b722268879a35779bd
+  metadata.gz: b38867e95d7ff4df6b99dccd34053aee236600eafae007ca2ff81c7a7ae8c30e
+  data.tar.gz: a8c7e2a15ea0330c21bd1303e21df32463c2d76f051fe29bdf3fc30da77ce9ca
 SHA512:
-  metadata.gz: bc146c9252add1af25853dd70416d790ba9bb5ad8b74adb6f1575e95b754cd6dcf5d5875112060b643493fcc4b970df156c8d8072db1d054c8f68a6c49faaf87
-  data.tar.gz: 33db19d5c8f58b4632206a82333fd526b708726b8fbed3d71ba8efe6841708a19d29e66e2a9f1357f7a3caab668c2ff132422e34116e45bbdc33b3c7aee79516
+  metadata.gz: 589d2010d44909cb6596974f08484729e29ba4963ae360d849f86f7d55361c68c262c3cb4d8a0376ea8c5efae24e5e80abb7a85e8985fff4f3a4db6994c28e47
+  data.tar.gz: 03f6ccdff3f5bacfe5395b5bcf6bff95fec5dc72695396f7395dff33947a6e7ce0a3c221226bd482672fcb24c3e2d09c4d02537cfea0c096488784f17fba80f0

data/README.md

@@ -12,6 +12,7 @@ Ruby Client library for IRIS / BBS API
 | 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` |
 
 ## Install
 
@@ -604,6 +605,7 @@ tn.delete()
 import_tn_order = {
     :customer_order_id => "id",
     :site_id => "12345",
+    :sip_peer_id => "23456",
     :subscriber => {
         :service_address => {
             :city => "city",
@@ -696,6 +698,71 @@ response = BandwidthIris::RemoveImportedTnOrders.create_remove_imported_tn_order
 puts response
 ```
 
+### Get LOAs
+```ruby
+response = BandwidthIris::ImportTnOrders.get_loa_files("order_id")
+puts response[0][:result_message]
+puts response[0][:file_names] #this can be a single string (if there's 1 file) or an array of strings (if there's multiple files)
+```
+
+### Upload LOA
+Valid `mime_types` can be found on the [Dashboard API Reference](https://dev.bandwidth.com/numbers/apiReference.html) under `/accounts /{accountId} /importTnOrders /{orderid} /loas`
+
+Mime types are expected to be in the format `x/y`, such as `application/pdf` or `text/plain`
+
+```ruby
+BandwidthIris::ImportTnOrders.upload_loa_file("order_id", "binary_file_contents", "mime_type")
+```
+
+```ruby
+f = open("loa.pdf", "rb")
+file_content = f.read
+f.close()
+
+BandwidthIris::ImportTnOrders.upload_loa_file("order_id", file_content, "application/pdf")
+```
+
+### Download LOA
+Note: Make sure to grab the desired file ID from the response of `BandwidthIris::ImportTnOrders.get_loa_files("order_id")` in the field `response[0][:file_names]`
+
+```ruby
+f = open("write.pdf", "wb")
+response = BandwidthIris::ImportTnOrders.download_loa_file("order_id", "file_id")
+f.puts(response)
+f.close()
+```
+
+### Replace LOA
+```ruby
+BandwidthIris::ImportTnOrders.replace_loa_file("order_id", "file_id", "binary_file_contents", "mime_type")
+```
+
+### Delete LOA
+```ruby
+BandwidthIris::ImportTnOrders.delete_loa_file("order_id", "file_id")
+```
+
+### Get LOA Metadata
+```ruby
+response = BandwidthIris::ImportTnOrders.get_loa_file_metadata("order_id", "file_id")
+puts response[0][:document_name]
+puts response[0][:file_name]
+```
+
+### Update LOA Metadata
+```ruby
+metadata = {
+    :document_name => "file_name",
+    :document_type => "LOA"    
+}
+BandwidthIris::ImportTnOrders.update_loa_file_metadata("order_id", "file_id", metadata)
+```
+
+### Delete LOA Metadata
+```ruby
+BandwidthIris::ImportTnOrders.delete_loa_file_metadata("order_id", "file_id")
+```
+
 ## CSR
 
 ### Create CSR Order

data/lib/bandwidth-iris/client.rb

@@ -83,6 +83,37 @@ module BandwidthIris
       [body || {}, symbolize(response.headers || {})]
     end
 
+    # Makes an HTTP request for file uploads
+    # @param method [Symbol] http method to make
+    # @param path [string] path of url (exclude api verion and endpoint) to make call
+    # @param data [string] the raw binary string representing the file to upload 
+    # @param content_type [string] the content type of the request
+    # @return [Array] array with 2 elements: parsed  data of response and response headers
+    def make_request_file_upload(method, path, data, content_type)
+      connection = @create_connection.call()
+      response = connection.run_request(method, @build_path.call(path), data, {'Content-Type' => content_type})
+      body = check_response(response)
+      [body || {}, symbolize(response.headers || {})]
+    end
+
+    # Makes an HTTP request for a file download
+    # @param method [Symbol] http method to make
+    # @param path [string] path of url (exclude api verion and endpoint) to make call
+    # @param data [Hash] data  which will be sent with request (for :get and :delete request they will be sent with query in url)
+    # @return [string] raw response from the API 
+    def make_request_file_download(method, path, data = {})
+      connection = @create_connection.call()
+      response =  if method == :get || method == :delete
+                    d  = camelcase(data)
+                    connection.run_request(method, @build_path.call(path), nil, nil) do |req|
+                      req.params = d unless d == nil || d.empty?
+                    end
+                  else
+                    connection.run_request(method, @build_path.call(path), build_xml(data), {'Content-Type' => 'application/xml'})
+                  end
+      return response.body
+    end
+
     # Check response object and raise error if status code >= 400
     # @param response response object
     def check_response(response)

data/lib/bandwidth-iris/import_tn_orders.rb

@@ -1,5 +1,5 @@
 module BandwidthIris
-  IMPORT_TN_ORDERS_PATH = "importTnOrders"
+  IMPORT_TN_ORDERS_PATH = "importtnorders"
 
   class ImportTnOrders
     extend ClientWrapper
@@ -28,5 +28,48 @@ module BandwidthIris
       return data
     end
     wrap_client_arg :create_import_tn_order
+
+    def self.get_loa_files(client, order_id)
+      data = client.make_request(:get, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}"))
+      return data
+    end
+    wrap_client_arg :get_loa_files
+
+    def self.upload_loa_file(client, order_id, file_contents, mime_type)
+      client.make_request_file_upload(:post, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}"), file_contents, mime_type)
+    end
+    wrap_client_arg :upload_loa_file
+
+    def self.download_loa_file(client, order_id, file_id)
+      data = client.make_request_file_download(:get, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}"))
+      return data
+    end
+    wrap_client_arg :download_loa_file
+
+    def self.replace_loa_file(client, order_id, file_id, file_contents, mime_type)
+      data = client.make_request_file_upload(:put, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}"), file_contents, mime_type)
+    end
+    wrap_client_arg :replace_loa_file
+
+    def self.delete_loa_file(client, order_id, file_id)
+      client.make_request(:delete, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}"))
+    end
+    wrap_client_arg :delete_loa_file
+
+    def self.get_loa_file_metadata(client, order_id, file_id)
+      data = client.make_request(:get, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}/metadata"))
+      return data
+    end
+    wrap_client_arg :get_loa_file_metadata
+
+    def self.update_loa_file_metadata(client, order_id, file_id, file_metadata)
+      client.make_request(:put, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}/metadata"), {:file_meta_data => file_metadata})
+    end
+    wrap_client_arg :update_loa_file_metadata
+
+    def self.delete_loa_file_metadata(client, order_id, file_id)
+      client.make_request(:delete, client.concat_account_path("#{IMPORT_TN_ORDERS_PATH}/#{order_id}/#{LOAS_PATH}/#{file_id}/metadata"))
+    end
+    wrap_client_arg :delete_loa_file_metadata
   end
 end

data/lib/bandwidth-iris/version.rb

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

data/spec/bandwidth-iris/import_tn_orders_spec.rb

@@ -11,7 +11,7 @@ describe BandwidthIris::ImportTnOrders do
 
   describe '#create' do
     it 'should get an order' do
-      client.stubs.get('/v1.0/accounts/accountId/importTnOrders', {}) {|env| [200, {}, '']}
+      client.stubs.get('/v1.0/accounts/accountId/importtnorders', {}) {|env| [200, {}, '']}
       item = ImportTnOrders.get_import_tn_orders(client)
     end
   end
@@ -19,7 +19,7 @@ describe BandwidthIris::ImportTnOrders do
   describe '#get' do
     it 'should get an order' do
       order = "123"
-      client.stubs.get("/v1.0/accounts/accountId/importTnOrders/#{order}", {}) {|env| [200, {}, '']}
+      client.stubs.get("/v1.0/accounts/accountId/importtnorders/#{order}", {}) {|env| [200, {}, '']}
       item = ImportTnOrders.get_import_tn_order(client, order)
     end
   end
@@ -27,7 +27,7 @@ describe BandwidthIris::ImportTnOrders do
   describe '#get history' do
     it 'should get an order history' do
       order = "123"
-      client.stubs.get("/v1.0/accounts/accountId/importTnOrders/#{order}/history", {}) {|env| [200, {}, '']}
+      client.stubs.get("/v1.0/accounts/accountId/importtnorders/#{order}/history", {}) {|env| [200, {}, '']}
       item = ImportTnOrders.get_import_tn_order_history(client, order)
     end
   end
@@ -37,8 +37,86 @@ describe BandwidthIris::ImportTnOrders do
       data = {
           :id => "id"
       }
-      client.stubs.post("/v1.0/accounts/accountId/importTnOrders", client.build_xml({:import_tn_order => data})) {|env| [200, {}, '']}
+      client.stubs.post("/v1.0/accounts/accountId/importtnorders", client.build_xml({:import_tn_order => data})) {|env| [200, {}, '']}
       item = ImportTnOrders.create_import_tn_order(client, data)
     end
   end
+
+  describe '#get loa files' do
+    it 'should get loa files' do
+      order = "123"
+      client.stubs.get("/v1.0/accounts/accountId/importtnorders/#{order}/loas") {|env| [200, {}, '']}
+      item = ImportTnOrders.get_loa_files(client, order)
+    end
+  end
+
+  describe '#upload loa file' do
+    it 'should upload loa file' do
+      file = '12345'
+      mime_type = 'text/plain'
+      order = '123'
+      client.stubs.post("/v1.0/accounts/accountId/importtnorders/#{order}/loas", file) {|env| [200, {}, '']}
+      item = ImportTnOrders.upload_loa_file(client, order, file, mime_type)
+    end
+  end
+
+  describe '#download loa file' do
+    it 'should download loa file' do
+      order = "123"
+      file_id = "456"
+      client.stubs.get("/v1.0/accounts/accountId/importtnorders/#{order}/loas/#{file_id}") {|env| [200, {}, '']}
+      item = ImportTnOrders.download_loa_file(client, order, file_id)
+    end
+  end
+
+  describe '#replace loa file' do
+    it 'should replace loa file' do
+      file = '12345'
+      mime_type = 'text/plain'
+      order = '123'
+      file_id = '456'
+      client.stubs.put("/v1.0/accounts/accountId/importtnorders/#{order}/loas/#{file_id}", file) {|env| [200, {}, '']}
+      item = ImportTnOrders.replace_loa_file(client, order, file_id, file, mime_type)
+    end
+  end
+
+  describe '#delete loa file' do
+    it 'should delete loa file' do
+      order = '123'
+      file_id = '456'
+      client.stubs.delete("/v1.0/accounts/accountId/importtnorders/#{order}/loas/#{file_id}") {|env| [200, {}, '']}
+      item = ImportTnOrders.delete_loa_file(client, order, file_id)
+    end
+  end
+
+  describe '#get loa file metadata' do
+    it 'should get loa file metadata' do
+      order = "123"
+      file_id = "456"
+      client.stubs.get("/v1.0/accounts/accountId/importtnorders/#{order}/loas/#{file_id}/metadata") {|env| [200, {}, '']}
+      item = ImportTnOrders.get_loa_file_metadata(client, order, file_id)
+    end
+  end
+  
+  describe '#update loa file metadata' do
+    it 'should update loa file metadata' do
+      data = {
+        :test => "1234"
+      }
+      order = "123"
+      file_id = "456"
+      client.stubs.put("/v1.0/accounts/accountId/importtnorders/#{order}/loas/#{file_id}/metadata", client.build_xml({:file_meta_data => data})) {|env| [200, {}, '']}
+      item = ImportTnOrders.update_loa_file_metadata(client, order, file_id, data)
+    end
+  end
+
+  describe '#delete loa file metadata' do
+    it 'should delete loa file metadata' do
+      order = "123"
+      file_id = "456"
+      client.stubs.delete("/v1.0/accounts/accountId/importtnorders/#{order}/loas/#{file_id}/metadata") {|env| [200, {}, '']}
+      item = ImportTnOrders.delete_loa_file_metadata(client, order, file_id)
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-bandwidth-iris
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Andrey Belchikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder