phaxio 2.0.0 → 2.1.0

data/spec/resources/account_spec.rb

@@ -1,16 +1,10 @@
 require 'spec_helper'
 
 RSpec.describe Account do
-  describe 'getting account information' do
+  describe 'getting account information', vcr: 'account/get' do
     let(:action) { Account.get params }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/account/status') do
-        example.run
-      end
-    end
-
     it 'sends the request to Phaxio' do
       expect_api_request :get, 'account/status', params
       action

data/spec/resources/ata_spec.rb

@@ -0,0 +1,207 @@
+require 'spec_helper'
+
+RSpec.describe Ata do
+  describe Ata::Reference, vcr: 'ata/reference' do
+    let(:reference) { Ata::Reference.new ata_id }
+    let(:ata_id) { Ata.create(name: 'Test ATA').id }
+
+    describe '#get' do
+      it 'returns information about the referenced ATA' do
+        result = reference.get
+        expect(result).to be_a(Ata)
+        expect(result.name).to eq('Test ATA')
+      end
+    end
+  end
+
+  describe Ata::ProvisioningURLs, vcr: 'ata/provisioning_urls' do
+    let(:provisioning_urls) { Ata.provisioning_urls }
+
+    describe '#urls' do
+      it 'returns the full hash of provisioning URLS' do
+        expect(provisioning_urls.urls).to be_a(Hash)
+        expect(provisioning_urls.urls.keys).to match_array([
+          'OBi',
+          'Grandstream',
+          'Netgen',
+        ])
+      end
+    end
+
+    describe '#grandstream' do
+      it 'returns the grandstream provisioning URL' do
+        url = provisioning_urls.urls['Grandstream']
+        expect(provisioning_urls.grandstream).to eq(url)
+      end
+    end
+
+    describe '#obi' do
+      it 'returns the obi provisioning URL' do
+        url = provisioning_urls.urls['OBi']
+        expect(provisioning_urls.obi).to eq(url)
+      end
+    end
+
+    describe '#netgen' do
+      it 'returns the netgen provisioning url' do
+        url = provisioning_urls.urls['Netgen']
+        expect(provisioning_urls.netgen).to eq(url)
+      end
+    end
+  end
+
+  describe 'getting a list of ATAs', vcr: 'ata/list' do
+    let(:action) { Ata.list params }
+    let(:params) { {} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :get, 'atas', params
+      action
+    end
+
+    it 'returns a collection of ATAs' do
+      result = action
+      expect(result).to be_a(Ata::Collection)
+    end
+  end
+
+  describe 'creating an ATA', vcr: 'ata/create' do
+    let(:action) { Ata.create params }
+    let(:params) { {name: 'Test ATA'} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :post, 'atas', name: 'Test ATA'
+      action
+    end
+
+    it 'returns information about the created ATA' do
+      result = action
+      expect(result).to be_a(Ata)
+      expect(result.name).to eq('Test ATA')
+    end
+  end
+
+  describe 'getting information about an ATA', vcr: 'ata/get' do
+    let(:action) { Ata.get ata_id, params }
+    let(:ata_id) { Ata.create(name: 'Test ATA').id }
+    let(:params) { {} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :get, "atas/#{ata_id}", params
+      action
+    end
+
+    it 'returns information about the ATA' do
+      result = action
+      expect(result).to be_a(Ata)
+      expect(result.name).to eq('Test ATA')
+    end
+  end
+
+  describe 'updating an ATA', vcr: 'ata/update' do
+    let(:action) { Ata.update ata_id, params }
+    let(:ata_id) { Ata.create(name: 'Test ATA').id }
+    let(:params) { {name: 'New Name'} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :patch, "atas/#{ata_id}", params
+      action
+    end
+
+    it 'returns information about the updated ATA' do
+      result = action
+      expect(result).to be_a(Ata)
+      expect(result.name).to eq('New Name')
+    end
+  end
+
+  describe 'regenerating ATA credentials', vcr: 'ata/regenerate' do
+    let(:action) { Ata.regenerate_credentials ata_id, params }
+    let(:ata) { Ata.create(name: 'Test ATA') }
+    let(:ata_id) { ata.id }
+    let(:params) { {} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :patch, "atas/#{ata_id}/regenerate_credentials", params
+      action
+    end
+
+    it 'returns information about the ATA' do
+      original_username = ata.username
+      # some actions don't return full creds; creation does, but run a sanity check just in case
+      expect(original_username).to_not be_nil
+      result = action
+      expect(result).to be_a(Ata)
+      expect(result.username).to_not eq(original_username)
+      expect(result.username).to_not be_nil
+    end
+  end
+
+  describe 'deleting an ATA', vcr: 'ata/delete' do
+    let(:action) { Ata.delete ata_id, params }
+    let(:ata_id) { Ata.create(name: 'Test ATA').id }
+    let(:params) { {} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :delete, "atas/#{ata_id}", params
+      action
+    end
+
+    it 'returns a reference to the deleted ATA' do
+      result = action
+      expect(result).to be_a(Ata::Reference)
+      expect(result.id).to eq(ata_id)
+    end
+  end
+
+  describe 'adding a phone number to an ATA', vcr: 'ata/add_phone_number' do
+    let(:action) { Ata.add_phone_number ata_id, TEST_NUMBER, params }
+    let(:ata_id) { Ata.create(name: 'Test ATA').id }
+    let(:params) { {} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :post, "atas/#{ata_id}/phone_numbers/#{TEST_NUMBER}", params
+      action
+    end
+
+    it 'returns a reference to the added phone number' do
+      result = action
+      expect(result).to be_a(PhoneNumber::Reference)
+    end
+  end
+
+  describe 'removing a phone number from an ATA', vcr: 'ata/remove_phone_number' do
+    let(:action) { Ata.remove_phone_number ata_id, TEST_NUMBER, params }
+    let(:ata_id) { Ata.create(name: 'Test ATA').id }
+    let(:params) { {} }
+
+    before do
+      Ata.add_phone_number ata_id, TEST_NUMBER
+    end
+
+    it 'sends the request to phaxio' do
+      expect_api_request :delete, "atas/#{ata_id}/phone_numbers/#{TEST_NUMBER}", params
+      action
+    end
+
+    it 'returns a reference to the removed phone number' do
+      result = action
+      expect(result).to be_a(PhoneNumber::Reference)
+    end
+  end
+
+  describe 'listing provisioning URLs for an ATA', vcr: 'ata/provisioning_urls' do
+    let(:action) { Ata.provisioning_urls params }
+    let(:params) { {} }
+
+    it 'sends the request to phaxio' do
+      expect_api_request :get, "atas/provisioning_urls", params
+      action
+    end
+
+    it 'returns a set of provisioning URLs' do
+      response = action
+      expect(response).to be_a(Ata::ProvisioningURLs)
+    end
+  end
+end

data/spec/resources/fax_spec.rb

@@ -2,19 +2,13 @@ require 'spec_helper'
 
 RSpec.describe Fax do
   let(:test_file) { File.open test_file_path }
-  let(:test_file_path) { File.expand_path(File.join('..', '..', 'support', 'files', 'test.pdf'), __FILE__) }
-  let(:test_recipient_number) { ENV.fetch 'TEST_RECIPIENT_NUMBER' }
+  let(:test_file_path) { File.join File.expand_path('..', __dir__), 'support', 'files', 'test.pdf' }
+  let(:test_recipient_number) { TEST_NUMBER }
 
-  describe 'creating a fax' do
+  describe 'creating a fax', vcr: 'fax/create' do
     let(:action) { Fax.create params }
     let(:params) { {to: test_recipient_number, file: test_file} }
 
-    around(:each) do |example|
-      VCR.use_cassette('resources/fax/create') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :post, 'faxes', to: test_recipient_number, file: test_file
       action
@@ -27,17 +21,11 @@ RSpec.describe Fax do
     end
   end
 
-  describe 'retrieving a fax' do
+  describe 'retrieving a fax', vcr: 'fax/get' do
     let(:action) { Fax.get fax_id, params }
-    let(:fax_id) { 1234 }
+    let(:fax_id) { Fax.create(to: test_recipient_number, file: test_file).id }
     let(:params) { {} }
 
-    around(:each) do |example|
-      VCR.use_cassette('resources/fax/get') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :get, "faxes/#{fax_id}", params
       action
@@ -50,47 +38,28 @@ RSpec.describe Fax do
     end
   end
 
-  # TODO: Refactor this
-  # This one's a little tricky, since it relies on having a fax to cancel.
-  describe 'cancelling a fax' do
-    let(:action) { Fax.cancel @fax_id, params }
+  describe 'cancelling a fax', vcr: 'fax/cancel' do
+    let(:action) { Fax.cancel fax_id, params }
+    let(:fax_id) { Fax.create(to: test_recipient_number, file: test_file).id }
     let(:params) { {} }
 
-    before do
-      VCR.use_cassette('resources/fax/create') do
-        @fax_id = Fax.create(to: test_recipient_number, file: test_file).id
-      end
-    end
-
-    around(:each) do |example|
-      VCR.use_cassette('resources/fax/cancel') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
-      expect_api_request :post, "faxes/#{@fax_id}/cancel", params
+      expect_api_request :post, "faxes/#{fax_id}/cancel", params
       action
     end
 
     it 'returns a reference to the fax' do
       result = action
       expect(result).to be_a(Fax::Reference)
-      expect(result.id).to eq(@fax_id)
+      expect(result.id).to eq(fax_id)
     end
   end
 
-  describe 'listing faxes' do
+  describe 'listing faxes', vcr: 'fax/list' do
     let(:action) { Fax.list params }
     let(:params) { {created_before: time} }
     let(:time) { Time.new 2017, 10, 28, 0, 17, 0, 0 }
 
-    around do |example|
-      VCR.use_cassette('resources/fax/list') do
-        example.run
-      end
-    end
-
     it 'sends the request to phaxio' do
       expect_api_request :get, 'faxes', params
       action
@@ -102,17 +71,15 @@ RSpec.describe Fax do
     end
   end
 
-  describe 'resending a fax' do
+  describe 'resending a fax', vcr: 'fax/resend' do
     let(:action) { Fax.resend fax_id, params }
-    let(:fax_id) { 1234 }
+    let(:fax_id) {
+      fax_id = Fax.create(to: test_recipient_number, file: test_file).id
+      sleep 30 if VCR.current_cassette.recording?
+      fax_id
+    }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/fax/resend') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :post, "faxes/#{fax_id}/resend", params
       action
@@ -125,17 +92,15 @@ RSpec.describe Fax do
     end
   end
 
-  describe 'deleting a fax' do
+  describe 'deleting a fax', vcr: 'fax/delete' do
     let(:action) { Fax.delete fax_id, params }
-    let(:fax_id) { 1234 }
+    let(:fax_id) {
+      fax_id = Fax.create(to: test_recipient_number, file: test_file).id
+      sleep 30 if VCR.current_cassette.recording?
+      fax_id
+    }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/fax/delete') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :delete, "faxes/#{fax_id}", params
       action
@@ -147,17 +112,15 @@ RSpec.describe Fax do
     end
   end
 
-  describe 'deleting a fax file' do
+  describe 'deleting a fax file', vcr: 'fax/delete_file' do
     let(:action) { Fax.delete_file fax_id, params }
-    let(:fax_id) { 1234 }
+    let(:fax_id) {
+      fax_id = Fax.create(to: test_recipient_number, file: test_file).id
+      sleep 30 if VCR.current_cassette.recording?
+      fax_id
+    }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/fax/delete_file') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :delete, "faxes/#{fax_id}/file", params
       action
@@ -169,17 +132,15 @@ RSpec.describe Fax do
     end
   end
 
-  describe 'downloading a fax file' do
+  describe 'downloading a fax file', vcr: 'fax/file' do
     let(:action) { Fax.file fax_id, params }
-    let(:fax_id) { 1234 }
+    let(:fax_id) {
+      fax_id = Fax.create(to: test_recipient_number, file: test_file).id
+      sleep 30 if VCR.current_cassette.recording?
+      fax_id
+    }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/fax/file') do
-        example.run
-      end
-    end
-
     it 'makes the request to phaxio' do
       expect_api_request :get, "faxes/#{fax_id}/file", params
       action
@@ -191,16 +152,10 @@ RSpec.describe Fax do
     end
   end
 
-  describe 'receiving a test fax' do
+  describe 'receiving a test fax', vcr: 'fax/test_receive' do
     let(:action) { Fax.test_receive params }
     let(:params) { {file: test_file} }
 
-    around do |example|
-      VCR.use_cassette('resources/fax/test_receive') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :post, 'faxes', {file: test_file, direction: 'received'}
       action
@@ -212,16 +167,14 @@ RSpec.describe Fax do
     end
   end
 
-  describe Fax::Reference do
-    let(:fax_id) { 1234 }
+  describe Fax::Reference, vcr: 'fax/reference' do
+    let(:fax_id) { Fax.create(to: test_recipient_number, file: test_file).id }
 
     it 'gets the full fax' do
-      VCR.use_cassette('resources/fax/get') do
-        reference = Fax::Reference.new fax_id
-        result = reference.get
-        expect(result).to be_a(Fax)
-        expect(result.id).to eq(1234)
-      end
+      reference = Fax::Reference.new fax_id
+      result = reference.get
+      expect(result).to be_a(Fax)
+      expect(result.id).to eq(fax_id)
     end
   end
 end

data/spec/resources/phax_code_spec.rb

@@ -5,23 +5,19 @@ RSpec.describe PhaxCode do
     let(:action) { PhaxCode.create params }
     let(:params) { {metadata: 'This is a test PhaxCode'} }
 
-    around do |example|
-      VCR.use_cassette('resources/phax_code/create') do
-        example.run
+    context 'default type', vcr: 'phax_code/create' do
+      it 'makes the request to phaxio' do
+        expect_api_request :post, 'phax_codes', params
+        action
       end
-    end
-
-    it 'makes the request to phaxio' do
-      expect_api_request :post, 'phax_codes', params
-      action
-    end
 
-    it 'returns a PhaxCode instance by default' do
-      result = action
-      expect(result).to be_a(PhaxCode)
+      it 'returns a PhaxCode instance by default' do
+        result = action
+        expect(result).to be_a(PhaxCode)
+      end
     end
 
-    context 'type is specified to be png' do
+    context 'type is specified to be png', vcr: 'phax_code/create_png' do
       let(:params) { {metadata: 'This is a test PhaxCode', type: 'png'} }
 
       it 'returns a png if type is specified to be png' do
@@ -35,25 +31,21 @@ RSpec.describe PhaxCode do
     let(:action) { PhaxCode.get params }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/phax_code/get') do
-        example.run
+    context 'default', vcr: 'phax_code/get_default' do
+      it 'makes the request to Phaxio' do
+        expect_api_request :get, 'phax_code', params
+        action
       end
-    end
-
-    it 'makes the request to Phaxio' do
-      expect_api_request :get, 'phax_code', params
-      action
-    end
 
-    context 'getting the default phax code with no type specified' do
-      it 'returns a PhaxCode instance' do
-        result = action
-        expect(result).to be_a(PhaxCode)
+      context 'getting the default phax code with no type specified' do
+        it 'returns a PhaxCode instance' do
+          result = action
+          expect(result).to be_a(PhaxCode)
+        end
       end
     end
 
-    context 'getting the default phax code with png type specified' do
+    context 'getting the default phax code with png type specified', vcr: 'phax_code/get_default_png' do
       let(:params) { {type: 'png'} }
 
       it 'returns a file' do
@@ -62,8 +54,9 @@ RSpec.describe PhaxCode do
       end
     end
 
-    context 'getting a particular phax code with no type specified' do
-      let(:params) { {identifier: '-Y3jxX'} }
+    context 'getting a particular phax code with no type specified', vcr: 'phax_code/get_by_id' do
+      let(:params) { {identifier: phax_code_identifier} }
+      let(:phax_code_identifier) { PhaxCode.create(metadata: 'Test Phax Code').identifier }
 
       it 'returns a PhaxCode instance' do
         result = action
@@ -71,8 +64,9 @@ RSpec.describe PhaxCode do
       end
     end
 
-    context 'getting a particular phax code with png type specified' do
-      let(:params) { {identifier: '-Y3jxX', type: 'png'} }
+    context 'getting a particular phax code with png type specified', vcr: 'phax_code/get_png_by_id' do
+      let(:params) { {identifier: phax_code_identifier, type: 'png'} }
+      let(:phax_code_identifier) { PhaxCode.create(metadata: 'Test Phax Code').identifier }
 
       it 'returns a file' do
         result = action
@@ -80,4 +74,4 @@ RSpec.describe PhaxCode do
       end
     end
   end
-end
+end

data/spec/resources/phone_number_spec.rb

@@ -1,15 +1,20 @@
 require 'spec_helper'
 
 RSpec.describe PhoneNumber do
-  describe 'provisioning a number' do
-    let(:action) { PhoneNumber.create params }
-    let(:params) { {country_code: 1, area_code: 225} }
-
-    around do |example|
-      VCR.use_cassette('resources/phone_number/create') do
-        example.run
+  describe PhoneNumber::Reference, vcr: 'phone_number/reference' do
+    describe '#get' do
+      it 'returns information about the referenced number' do
+        reference = PhoneNumber::Reference.new TEST_NUMBER
+        result = reference.get
+        expect(result).to be_a(PhoneNumber)
+        expect(result.phone_number).to eq(TEST_NUMBER)
       end
     end
+  end
+
+  describe 'provisioning a number', vcr: 'phone_number/create' do
+    let(:action) { PhoneNumber.create params }
+    let(:params) { {country_code: 1, area_code: 225} }
 
     it 'makes the request to Phaxio' do
       expect_api_request :post, 'phone_numbers', params
@@ -22,17 +27,11 @@ RSpec.describe PhoneNumber do
     end
   end
 
-  describe 'getting information about a number' do
+  describe 'getting information about a number', vcr: 'phone_number/get' do
     let(:action) { PhoneNumber.get phone_number, params }
-    let(:phone_number) { '12258675309' }
+    let(:phone_number) { TEST_NUMBER }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/phone_number/get') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :get, "phone_numbers/#{phone_number}"
       action
@@ -44,16 +43,10 @@ RSpec.describe PhoneNumber do
     end
   end
 
-  describe 'listing numbers' do
+  describe 'listing numbers', vcr: 'phone_number/list' do
     let(:action) { PhoneNumber.list params }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/phone_number/list') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :get, 'phone_numbers', params
       action
@@ -65,17 +58,13 @@ RSpec.describe PhoneNumber do
     end
   end
 
-  describe 'releasing a number' do
+  describe 'releasing a number', vcr: 'phone_number/release' do
     let(:action) { PhoneNumber.release phone_number, params }
-    let(:phone_number) { '+12258675309' }
+    let(:phone_number) {
+      PhoneNumber.provision(country_code: 1, area_code: 225).phone_number
+    }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/phone_number/release') do
-        example.run
-      end
-    end
-
     it 'sends the request to Phaxio' do
       expect_api_request :delete, "phone_numbers/#{phone_number}", params
       action

data/spec/resources/port_number_note_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe PortNumberNote do
+  describe 'getting a list of notes', vcr: 'port_number_note/list' do
+    let(:action) { PortNumberNote.list port_number_id, params }
+    let(:port_number_id) {
+      PortOrder.create(
+        port_numbers: [TEST_NUMBER],
+        contact_number: TEST_NUMBER,
+        contact_email: 'julien@phaxio.com',
+        account_identifier: '1234',
+        name_on_account: 'THIS IS A TEST',
+        provider_name: 'DO NOT PORT --Julien',
+        has_bill: true,
+        legal_agreement: true,
+        port_type: 'residential',
+        esig: 'NOT A VALID SIGNATURE'
+      ).port_numbers[0].id
+    }
+
+    let(:params) { {} }
+
+    it 'makes the request to phaxio' do
+      expect_api_request :get, "port_numbers/#{port_number_id}/notes", params
+      action
+    end
+
+    it 'returns a collection of port number note objects' do
+      result = action
+      expect(result).to be_a(Phaxio::Resource::Collection)
+    end
+  end
+end