Porting resources and cleanup

Author: jtnegrotto

lib/phaxio.rb

@@ -18,7 +18,7 @@
 end
 
 %w[
-  fax_recipient fax account webhook phax_code phone_number public ata
+  fax_recipient fax account callback webhook phax_code phone_number public ata
   port_number_note port_number port_order
 ].each do |filename|
   require File.expand_path(File.join('..', 'phaxio', 'resources', filename), __FILE__)
@@ -34,9 +34,11 @@ class << self
     #   @see Config.api_secret
     # @!attribute webhook_token
     #   @see Config.webhook_token
+    # @!attribute callback_token
+    #   @see Config.webhook_token
     # @!attribute api_endpoint
     #   @see Config.api_endpoint
-    %w(api_key api_secret webhook_token api_endpoint).each do |config_attribute|
+    %w(api_key api_secret webhook_token callback_token api_endpoint).each do |config_attribute|
       # Define getters
       define_method(config_attribute) do
         Config.public_send config_attribute

lib/phaxio/config.rb

@@ -18,6 +18,8 @@ class << self
       #
       # To find your webhook token, visit https://console.phaxio.com/user/callbacks/edit
       attr_accessor :webhook_token
+      alias callback_token webhook_token
+      alias callback_token= webhook_token=
 
       # The Phaxio API endpoint. Users generally shouldn't need to change it.
       # Defaults to https://api.phaxio.com/v2.1/

lib/phaxio/resource.rb

@@ -139,12 +139,18 @@ class Collection
       #
       # @see Phaxio::Resource.response_collection
       def initialize response_data, resource
-        if response_data.key? 'paging'
-          self.total = response_data['paging']['total']
-          self.per_page = response_data['paging']['per_page']
-          self.page = response_data['paging']['page']
+        # For some endpoints we'll get a hash with `paging` and `data` attributes.
+        # For others, just an array.
+        if response_data.is_a? Hash
+          if response_data.key? 'paging'
+            self.total = response_data['paging']['total']
+            self.per_page = response_data['paging']['per_page']
+            self.page = response_data['paging']['page']
+          end
+          self.raw_data = response_data['data']
+        else
+          self.raw_data = response_data
         end
-        self.raw_data = response_data['data']
         self.collection = raw_data.map { |record_data| resource.response_record record_data }
       end
 

lib/phaxio/resources/callback.rb

@@ -0,0 +1,19 @@
+module Phaxio
+  module Resources
+    # This class is provided for the sake of backwards compatibility; use the Webhook resource instead.
+    # @see Phaxio::Resources::Webhook
+    class Callback
+      class << self
+        def valid_signature? *args
+          Phaxio::Resources::Webhook.valid_signature? *args
+        rescue Error::PhaxioError => error
+          if error.message == 'No webhook token has been set'
+            raise Error::PhaxioError, 'No callback token has been set'
+          else
+            raise error
+          end
+        end
+      end
+    end
+  end
+end

lib/phaxio/resources/port_number_note.rb

@@ -39,7 +39,7 @@ def list port_number_id, params = {}
           response = Client.request :get, port_number_notes_endpoint(port_number_id.to_i), params
           response_collection response
         end
-        
+
         private
 
         def port_number_notes_endpoint port_number_id

lib/phaxio/resources/webhook.rb

@@ -1,6 +1,6 @@
 module Phaxio
   module Resources
-    # Provides utilities for working with callbacks.
+    # Provides utilities for working with webhooks.
     # @see https://www.phaxio.com/docs/api/v2.1/faxes/send_webhook
     # @see https://www.phaxio.com/docs/api/v2.1/faxes/receive_webhooks
     class Webhook
@@ -61,8 +61,5 @@ def generate_file_string(file)
         end
       end
     end
-
-    # for backwards compatibility
-    Callback = Webhook
   end
 end

lib/phaxio/version.rb

@@ -1,3 +1,3 @@
 module Phaxio
-  VERSION = "2.1.0.pre"
+  VERSION = "2.1.0"
 end

spec/phaxio_spec.rb

@@ -17,4 +17,10 @@
     subject.webhook_token = 'test-webhook-token'
     expect(subject.webhook_token).to eq('test-webhook-token')
   end
+
+  it 'sets and gets the webhook token as callback_token' do
+    subject.callback_token = 'test-callback-token'
+    expect(subject.callback_token).to eq('test-callback-token')
+    expect(subject.webhook_token).to eq('test-callback-token')
+  end
 end

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

spec/resources/fax_spec.rb

@@ -2,19 +2,13 @@
 
 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 @@
     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 @@
     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 @@
     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 @@
     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 @@
     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 @@
     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 @@
     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 @@
     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 @@
     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