Rename callback to webhook

Author: yujideveloper

README.md

@@ -26,14 +26,14 @@ $ gem install phaxio
 
 ## Usage
 
-Set up your API Key, API Secret, and, optionally, Callback Token.
+Set up your API Key, API Secret, and, optionally, Webhook Token.
 
 ``` ruby
 require 'phaxio'
 
 Phaxio.api_key = '11111'
 Phaxio.api_secret = '22222'
-Phaxio.callback_token = '33333'
+Phaxio.webhook_token = '33333'
 ```
 
 Try sending a fax:
@@ -243,32 +243,32 @@ Account.get
 # => Account(balance: 1000, faxes_today: 0, faxes_this_month: 100)
 ```
 
-#### Callback
+#### Webhook
 
-##### `Callback.valid_signature?`
+##### `Webhook.valid_signature?`
 
-Validate the callback signature sent with a Phaxio callback. Requires that Phaxio.callback_token be
+Validate the webhook signature sent with a Phaxio webhook. Requires that Phaxio.webhook_token be
 set.
 
 ``` ruby
-Callback.valid_signature? received_signature, callback_url, received_params, received_files
+Webhook.valid_signature? received_signature, webhook_url, received_params, received_files
 # => true
 ```
 
-## Callback Validation Example with Sinatra
+## Webhook Validation Example with Sinatra
 
 ``` ruby
 require 'sinatra/base'
 require 'phaxio'
 
 class PhaxioWebhookExample < Sinatra::Base
-  Phaxio.callback_token = 'YOUR WEBHOOK TOKEN HERE'
-  
+  Phaxio.webhook_token = 'YOUR WEBHOOK TOKEN HERE'
+
   post '/webhook' do
     signature = request.env['HTTP_X_PHAXIO_SIGNATURE']
     url = request.url
     file_params = params[:file]
-    if Phaxio::Callback.valid_signature? signature, url, webhook_params, file_params
+    if Phaxio::Webhook.valid_signature? signature, url, webhook_params, file_params
       'Success'
     else
       'Invalid webhook signature'
@@ -289,22 +289,22 @@ end
 class WebhookController < ApplicationController
   skip_before_action :verify_authenticity_token
 
-	def index
+  def index
     signature = request.headers['X-Phaxio-Signature']  
-    Phaxio.callback_token = 'YOUR WEBHOOK TOKEN HERE'
+    Phaxio.webhook_token = 'YOUR WEBHOOK TOKEN HERE'
     url = request.original_url
 
     Rails.logger.debug "URL: " + url
     Rails.logger.debug "Signature: " + signature
     Rails.logger.debug "params: " + params.inspect
     Rails.logger.debug "webhook_params: " + webhook_params.to_h.inspect
-    
-    if Phaxio::Callback.valid_signature? signature, url, webhook_params.to_h, file_params
+
+    if Phaxio::Webhook.valid_signature? signature, url, webhook_params.to_h, file_params
       Rails.logger.debug "Success"
       render plain: 'Success'
     else
-      Rails.logger.debug "Invalid callback signature"
-      render plain: 'Invalid callback signature'
+      Rails.logger.debug "Invalid webhook signature"
+      render plain: 'Invalid webhook signature'
     end
   end
 

lib/phaxio.rb

@@ -18,7 +18,7 @@
 end
 
 %w[
-  fax_recipient fax account callback phax_code phone_number public ata
+  fax_recipient fax account 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__)
@@ -32,11 +32,11 @@ class << self
     #   @see Config.api_key
     # @!attribute api_secret
     #   @see Config.api_secret
-    # @!attribute callback_token
-    #   @see Config.callback_token
+    # @!attribute webhook_token
+    #   @see Config.webhook_token
     # @!attribute api_endpoint
     #   @see Config.api_endpoint
-    %w(api_key api_secret callback_token api_endpoint).each do |config_attribute|
+    %w(api_key api_secret webhook_token api_endpoint).each do |config_attribute|
       # Define getters
       define_method(config_attribute) do
         Config.public_send config_attribute
@@ -48,5 +48,9 @@ class << self
         Config.public_send setter, value
       end
     end
+
+    # for backwards compatibility
+    alias callback_token  webhook_token
+    alias callback_token= webhook_token=
   end
 end

lib/phaxio/config.rb

@@ -13,11 +13,11 @@ class << self
       # To find your API secret, visit https://console.phaxio.com/api_credentials
       attr_accessor :api_secret
 
-      # Your Phaxio callback token. This will be used to verify that callback requests are coming
+      # Your Phaxio webhook token. This will be used to verify that webhook requests are coming
       # from Phaxio.
       #
-      # To find your callback token, visit https://console.phaxio.com/user/callbacks/edit
-      attr_accessor :callback_token
+      # To find your webhook token, visit https://console.phaxio.com/user/callbacks/edit
+      attr_accessor :webhook_token
 
       # The Phaxio API endpoint. Users generally shouldn't need to change it.
       # Defaults to https://api.phaxio.com/v2.1/

lib/phaxio/resources/callback.rb lib/phaxio/resources/webhook.rblib/phaxio/resources/callback.rb renamed to lib/phaxio/resources/webhook.rb

@@ -3,7 +3,7 @@ module Resources
     # Provides utilities for working with callbacks.
     # @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 Callback
+    class Webhook
       DIGEST = OpenSSL::Digest.new('sha1')
       private_constant :DIGEST
 
@@ -13,11 +13,11 @@ class << self
         # @param signature [String]
         #   The signature received from Phaxio.
         # @param url [String]
-        #   The callback URL used in this request.
+        #   The webhook URL used in this request.
         # @param params [Hash]
-        #   The parameters received with the callback, excluding files.
+        #   The parameters received with the webhook, excluding files.
         # @param files [Array<File>]
-        #   The files received with the callback, if any.
+        #   The files received with the webhook, if any.
         # @return [true, false]
         # @raise [Phaxio::Error::PhaxioError]
         # @see https://www.phaxio.com/docs/security/callbacks
@@ -31,12 +31,12 @@ def valid_signature? signature, url, params, files = []
         def generate_check_signature url, params, files = []
           params_string = generate_params_string(params)
           files_string = generate_files_string(files)
-          callback_data = "#{url}#{params_string}#{files_string}"
-          OpenSSL::HMAC.hexdigest(DIGEST, callback_token, callback_data)
+          webhook_data = "#{url}#{params_string}#{files_string}"
+          OpenSSL::HMAC.hexdigest(DIGEST, webhook_token, webhook_data)
         end
 
-        def callback_token
-          Phaxio.callback_token or raise(Error::PhaxioError, 'No callback token has been set')
+        def webhook_token
+          Phaxio.webhook_token or raise(Error::PhaxioError, 'No webhook token has been set')
         end
 
         def generate_params_string(params)
@@ -61,5 +61,8 @@ def generate_file_string(file)
         end
       end
     end
+
+    # for backwards compatibility
+    Callback = Webhook
   end
 end

spec/phaxio_spec.rb

@@ -13,8 +13,8 @@
     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')
+  it 'sets the webhook token' do
+    subject.webhook_token = 'test-webhook-token'
+    expect(subject.webhook_token).to eq('test-webhook-token')
   end
 end

spec/resources/callback_spec.rb spec/resources/webhook_spec.rbspec/resources/callback_spec.rb renamed to spec/resources/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 @@
       end
     end
   end
-end
+end

spec/support/credentials.rb

@@ -2,6 +2,6 @@
   config.before(:each) do
     Phaxio.api_key = ENV['PHAXIO_API_KEY'] || 'test-api-key'
     Phaxio.api_secret = ENV['PHAXIO_API_SECRET'] || 'test-api-secret'
-    Phaxio.callback_token = ENV['PHAXIO_CALLBACK_TOKEN'] || 'test-callback-token'
+    Phaxio.webhook_token = ENV['PHAXIO_WEBHOOK_TOKEN'] || 'test-webhook-token'
   end
 end