phaxio 0.4.0 → 2.1.0.pre

data/spec/phaxio_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+RSpec.describe Phaxio do
+  subject { Phaxio }
+
+  it 'sets the api key' do
+    subject.api_key = 'test-api-key'
+    expect(subject.api_key).to eq('test-api-key')
+  end
+
+  it 'sets the api secret' do
+    subject.api_secret = 'test-api-secret'
+    expect(subject.api_secret).to eq('test-api-secret')
+  end
+
+  it 'sets the callback token' do
+    subject.callback_token = 'test-callback-token'
+    expect(subject.callback_token).to eq('test-callback-token')
+  end
+end

data/spec/resources/account_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe Account do
+  describe 'getting account information' 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
+    end
+
+    it 'returns an account object' do
+      result = action
+      expect(result).to be_a(Account)
+    end
+  end
+end

data/spec/resources/callback_spec.rb

@@ -0,0 +1,34 @@
+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' }
+    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
+      expect {
+        action
+      }.to raise_error(Phaxio::Error::PhaxioError, 'No callback token has been set')
+    end
+
+    context 'signature matches' do
+      it 'returns true' do
+        result = action
+        expect(result).to eq(true)
+      end
+    end
+
+    context 'signature does not match' do
+      let(:signature) { 'wrong' }
+
+      it 'returns false' do
+        result = action
+        expect(result).to eq(false)
+      end
+    end
+  end
+end

data/spec/resources/fax_spec.rb

@@ -0,0 +1,248 @@
+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') }
+
+  describe 'creating a fax' 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
+    end
+
+    it 'returns a reference to the fax' do
+      result = action
+      expect(result).to be_a(Fax::Reference)
+      expect(result.id).to be_a(Integer)
+    end
+  end
+
+  describe 'retrieving a fax' 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(: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
+    end
+
+    it 'returns a fax' do
+      result = action
+      expect(result).to be_a(Fax)
+      expect(result.id).to eq(fax_id)
+    end
+  end
+
+  describe 'cancelling a fax' do
+    let(:action) { Fax.cancel fax_id, params }
+    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
+      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)
+    end
+  end
+
+  describe 'listing faxes' 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
+    end
+
+    it 'returns a collection of faxes' do
+      result = action
+      expect(result).to be_a(Fax::Collection)
+    end
+  end
+
+  describe 'resending a fax' 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(: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
+    end
+
+    it 'returns a reference to a new fax' do
+      result = action
+      expect(result).to be_a(Fax::Reference)
+      expect(result.id).to_not eq(fax_id)
+    end
+  end
+
+  describe 'deleting a fax' 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(: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
+    end
+
+    it 'returns true' do
+      result = action
+      expect(result).to eq(true)
+    end
+  end
+
+  describe 'deleting a fax 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(: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
+    end
+
+    it 'returns true' do
+      result = action
+      expect(result).to eq(true)
+    end
+  end
+
+  describe 'downloading a 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(: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
+    end
+
+    it 'returns a file' do
+      result = action
+      expect(result).to be_a(File)
+    end
+  end
+
+  describe 'receiving a test fax' 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
+    end
+
+    it 'returns true' do
+      result = action
+      expect(result).to eq(true)
+    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
+    }
+
+    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
+    end
+  end
+end

data/spec/resources/phax_code_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+RSpec.describe PhaxCode do
+  describe 'creating a phax code' 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
+
+      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)
+      end
+    end
+
+    context 'type is specified to be 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)
+      end
+    end
+  end
+
+  describe 'getting a phax code' 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
+
+      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)
+        end
+      end
+    end
+
+    context 'getting the default phax code with png type specified' 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
+
+      it 'returns a PhaxCode instance' do
+        result = action
+        expect(result).to be_a(PhaxCode)
+      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
+
+      it 'returns a file' do
+        result = action
+        expect(result).to be_a(File)
+      end
+    end
+  end
+end

data/spec/resources/phone_number_spec.rb

@@ -0,0 +1,89 @@
+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
+      end
+    end
+
+    it 'makes the request to Phaxio' do
+      expect_api_request :post, 'phone_numbers', params
+      action
+    end
+
+    it 'returns a phone number object' do
+      result = action
+      expect(result).to be_a(PhoneNumber)
+    end
+  end
+
+  describe 'getting information about a number' do
+    let(:action) { PhoneNumber.get phone_number, params }
+    let(:phone_number) { '12258675309' }
+    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
+    end
+
+    it 'returns a phone number object' do
+      result = action
+      expect(result).to be_a(PhoneNumber)
+    end
+  end
+
+  describe 'listing numbers' 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
+    end
+
+    it 'returns a collection of phone number objects' do
+      result = action
+      expect(result).to be_a(Phaxio::Resource::Collection)
+    end
+  end
+
+  describe 'releasing a number' do
+    let(:action) { PhoneNumber.release phone_number, params }
+    let(:phone_number) { '+12258675309' }
+    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
+    end
+
+    it 'returns true' do
+      result = action
+      expect(result).to eq(true)
+    end
+  end
+end