phaxio 2.1.0.pre → 2.1.0

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', '+15558675309') }
+  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,21 +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) {
-      VCR.use_cassette('resources/fax/create_for_get') do
-        Phaxio::Fax.create(to: test_recipient_number, file: test_file).id
-      end
-    }
+    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
@@ -54,20 +38,10 @@ RSpec.describe Fax do
     end
   end
 
-  describe 'cancelling a fax' do
+  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) { {} }
-    let!(:fax_id) {
-      VCR.use_cassette('resources/fax/create_for_cancel') do
-        Phaxio::Fax.create(to: test_recipient_number, file: test_file).id
-      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
@@ -81,17 +55,11 @@ RSpec.describe Fax do
     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
@@ -103,21 +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) {
-      VCR.use_cassette('resources/fax/create_for_resend') do
-        Phaxio::Fax.create(to: test_recipient_number, file: test_file).id
-      end
+    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
@@ -130,21 +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) {
-      VCR.use_cassette('resources/fax/create_for_delete') do
-        Phaxio::Fax.create(to: test_recipient_number, file: test_file).id
-      end
+    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
@@ -156,21 +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) {
-      VCR.use_cassette('resources/fax/create_for_delete_file') do
-        Phaxio::Fax.create(to: test_recipient_number, file: test_file).id
-      end
+    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
@@ -182,21 +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) {
-      VCR.use_cassette('resources/fax/create_for_download_file') do
-        Phaxio::Fax.create(to: test_recipient_number, file: test_file).id
-      end
+    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
@@ -208,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
@@ -229,20 +167,14 @@ RSpec.describe Fax do
     end
   end
 
-  describe Fax::Reference do
-    let!(:fax_id) {
-      VCR.use_cassette('resources/fax/create_for_reference') do
-        Phaxio::Fax.create(to: test_recipient_number, file: test_file).id
-      end
-    }
+  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/reference') do
-        reference = Fax::Reference.new fax_id
-        result = reference.get
-        expect(result).to be_a(Fax)
-        expect(result.id).to eq(fax_id)
-      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,13 +5,7 @@ RSpec.describe PhaxCode do
     let(:action) { PhaxCode.create params }
     let(:params) { {metadata: 'This is a test PhaxCode'} }
 
-    context 'default type' do
-      around do |example|
-        VCR.use_cassette('resources/phax_code/create') do
-          example.run
-        end
-      end
-
+    context 'default type', vcr: 'phax_code/create' do
       it 'makes the request to phaxio' do
         expect_api_request :post, 'phax_codes', params
         action
@@ -23,15 +17,9 @@ RSpec.describe PhaxCode do
       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'} }
 
-      around do |example|
-        VCR.use_cassette('resources/phax_code/create_png') do
-          example.run
-        end
-      end
-
       it 'returns a png if type is specified to be png' do
         result = action
         expect(result).to be_a(File)
@@ -43,13 +31,7 @@ RSpec.describe PhaxCode do
     let(:action) { PhaxCode.get params }
     let(:params) { {} }
 
-    context 'default' do
-      around do |example|
-        VCR.use_cassette('resources/phax_code/get') do
-          example.run
-        end
-      end
-
+    context 'default', vcr: 'phax_code/get_default' do
       it 'makes the request to Phaxio' do
         expect_api_request :get, 'phax_code', params
         action
@@ -63,29 +45,18 @@ RSpec.describe PhaxCode do
       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'} }
 
-      around do |example|
-        VCR.use_cassette('resources/phax_code/get_png') do
-          example.run
-        end
-      end
-
       it 'returns a file' do
         result = action
         expect(result).to be_a(File)
       end
     end
 
-    context 'getting a particular phax code with no type specified' do
-      let(:params) { {identifier: '-Y3jxX'} }
-
-      around do |example|
-        VCR.use_cassette('resources/phax_code/get_id') do
-          example.run
-        end
-      end
+    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
@@ -93,14 +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'} }
-
-      around do |example|
-        VCR.use_cassette('resources/phax_code/get_id_png') do
-          example.run
-        end
-      end
+    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

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

data/spec/resources/port_number_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+RSpec.describe PortNumber do
+  describe 'getting information about a number', vcr: 'port_number/get' do
+    let(:action) { PortNumber.get id, params }
+    let(: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/#{id}", params
+      action
+    end
+
+    it 'returns a port number object' do
+      result = action
+      expect(result).to be_a(PortNumber)
+    end
+  end
+end

data/spec/resources/port_order_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+RSpec.describe PortOrder do
+  describe 'creating an order', vcr: 'port_order/create' do
+    let(:action) { PortOrder.create params }
+    let(:params) {
+      {
+        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'
+      }
+    }
+
+    it 'makes the request to Phaxio' do
+      expect_api_request :post, 'port_orders', params
+      action
+    end
+
+    it 'returns a port order object' do
+      result = action
+      expect(result).to be_a(PortOrder)
+    end
+  end
+  
+  describe 'getting information about an order', vcr: 'port_order/get' do
+    let(:action) { PortOrder.get id, params }
+    let(: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'
+      ).id
+    }
+    let(:params) { {} }
+
+    it 'makes the request to Phaxio' do
+      expect_api_request :get, "port_orders/#{id}", params
+      action
+    end
+
+    it 'returns a port order object' do
+      result = action
+      expect(result).to be_a(PortOrder)
+    end
+  end
+
+  describe 'listing port orders', vcr: 'port_order/list' do
+    let(:action) { PortOrder.list params }
+    let(:params) { {} }
+
+    it 'makes the request to Phaxio' do
+      expect_api_request :get, 'port_orders', params
+      action
+    end
+
+    it 'returns a collection of port order objects' do
+      result = action
+      expect(result).to be_a(Phaxio::Resource::Collection)
+      expect(result.first).to be_a(PortOrder)
+    end
+  end
+end

data/spec/resources/public/area_code_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 RSpec.describe Public::AreaCode do
-  describe 'listing area codes available for purchasing numbers' do
+  describe 'listing area codes available for purchasing numbers', vcr: 'public/area_code/list' do
     let(:action) { Public::AreaCode.list params }
     let(:params) { {} }
 

data/spec/resources/public/country_spec.rb

@@ -1,16 +1,10 @@
 require 'spec_helper'
 
 RSpec.describe Public::Country do
-  describe 'getting a list of supported countries' do
+  describe 'getting a list of supported countries', vcr: 'public/country/list' do
     let(:action) { Public::Country.list }
     let(:params) { {} }
 
-    around do |example|
-      VCR.use_cassette('resources/public/country/list') do
-        example.run
-      end
-    end
-
     it 'makes the request to Phaxio' do
       expect_api_request :get, 'public/countries', params
       action

data/spec/resources/{callback_spec.rb → webhook_spec.rb}

@@ -1,18 +1,18 @@
 require 'spec_helper'
 
-RSpec.describe Callback do
-  describe 'validating a callback signature' do
-    let(:action) { Callback.valid_signature? signature, url, params, files }
-    let(:signature) { '663099785e5eff09f0cd6f2bd5d78c852f3b670d' }
+RSpec.describe Webhook do
+  describe 'validating a webhook signature' do
+    let(:action) { Webhook.valid_signature? signature, url, params, files }
+    let(:signature) { '64a735ef0c47a0ae671e381c046648f0966deb29' }
     let(:url) { 'example.com' }
     let(:params) { {test: true} }
     let(:files) { [] }
 
-    it 'raises an error if Phaxio::Config.callback_token is unset' do
-      Phaxio.callback_token = nil
+    it 'raises an error if Phaxio::Config.webhook_token is unset' do
+      Phaxio.webhook_token = nil
       expect {
         action
-      }.to raise_error(Phaxio::Error::PhaxioError, 'No callback token has been set')
+      }.to raise_error(Phaxio::Error::PhaxioError, 'No webhook token has been set')
     end
 
     context 'signature matches' do
@@ -31,4 +31,4 @@ RSpec.describe Callback do
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -4,3 +4,4 @@ require File.expand_path(File.join(['..', '..', 'lib', 'phaxio']), __FILE__)
 Dir[File.expand_path(File.join(['..', 'support', '**', '*.rb']), __FILE__)].each { |file| require file }
 
 include Phaxio::Resources
+

data/spec/support/{vcr_cassettes/resources/account/status.yml → cassettes/account/get.yml}

@@ -7,10 +7,10 @@ http_interactions:
       encoding: US-ASCII
       string: ''
     headers:
-      Authorization:
-      - Basic dGVzdC1hcGkta2V5OnRlc3QtYXBpLXNlY3JldA==
       User-Agent:
       - Faraday v1.3.0
+      Authorization:
+      - "<AUTH_HEADER>"
   response:
     status:
       code: 200
@@ -21,25 +21,23 @@ http_interactions:
       content-type:
       - application/json; charset=utf-8
       date:
-      - Wed, 24 Feb 2021 19:38:10 GMT
+      - Thu, 04 Nov 2021 21:07:44 GMT
       etag:
-      - W/"fdf78451cea62a6da8f7a06bb945480d"
+      - W/"ec3c8a9d370f99638f5670ec4ac6fc00"
       server:
       - nginx
       strict-transport-security:
       - max-age=15768000; preload
       x-request-id:
-      - a07420ca-8a4f-4a40-aeab-076a41813577
+      - e9708d49-deff-443c-92cb-2d89a3ef7272
       x-robots-tag:
       - noindex, nofollow, nosnippet, noarchive
-      x-runtime:
-      - '0.022529'
       content-length:
       - '171'
       connection:
       - keep-alive
     body:
       encoding: UTF-8
-      string: '{"success":true,"message":"Account status retrieved successfully","data":{"balance":8325,"faxes_today":{"sent":6,"received":8},"faxes_this_month":{"sent":6,"received":8}}}'
-  recorded_at: Wed, 24 Feb 2021 19:37:23 GMT
+      string: '{"success":true,"message":"Account status retrieved successfully","data":{"balance":1076,"faxes_today":{"sent":0,"received":0},"faxes_this_month":{"sent":0,"received":0}}}'
+  recorded_at: Thu, 04 Nov 2021 21:08:25 GMT
 recorded_with: VCR 6.0.0