phaxio 2.0.1 → 2.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12ce42728923c83667571c73e2c0320f41a3f579
-  data.tar.gz: f6840ec8c126853273bd76f68d3399b3f5a24989
+SHA256:
+  metadata.gz: 7f20cd3d8695312c8b64cf40cc01b8fe0e320b921a3527abc1ca005a9d140b11
+  data.tar.gz: '088662055ff2bd6ebbeb5055ad7316bd6d99acf9a93249383d9ad1aa08133a4b'
 SHA512:
-  metadata.gz: 3f805c26607a691b2af4e692cd5c8c6cf4b24a624b711527f72e85ee49287071369087e261d41eb292a7a9747cf32e26cd7ac67f3b15018d906cf1c9a8a4ceeb
-  data.tar.gz: a1bc1b11cfa3244f1361a526c0439bfc9dab5c82efe45e80ee888c5d01920af8e190dc5336b232980d0c57ee3162f3ffa6c5220ecba65b5fc98c577a92275526
+  metadata.gz: 99cfc91fefd07016507eb20049f5c7afeca903d2c227941bcd55a1cd14913faa1b03e69a2ceea1798da457bf338a48e5ad7c212f107aba598378965210a0d24a
+  data.tar.gz: cf3b858ff97a2b005f50a21709ee524fd20b6fc12080a59a48d57842b9e295f18de91a20f48ba5f9f1b64d632e5a38d7d375b0af8e323cea2232df49421deb93

data/Gemfile

@@ -4,10 +4,11 @@ gemspec
 
 group :development do
   gem 'bundler'
-  gem 'rake', '~> 10'
+  gem 'rake'
   gem 'rspec', '~> 3.7'
   gem 'vcr'
   gem 'webmock'
   gem 'pry'
   gem 'yard'
+  gem 'dotenv', require: false
 end

data/README.md

@@ -261,27 +261,60 @@ Callback.valid_signature? received_signature, callback_url, received_params, rec
 require 'sinatra/base'
 require 'phaxio'
 
-class PhaxioCallbackExample < Sinatra::Base
-  Phaxio.config do |config|
-    config.api_key = '0123456789'
-    config.api_secret = '0123456789'
-    config.callback_token = '0123456789'
-  end
-
-  post '/phaxio_callback' do
+class PhaxioWebhookExample < Sinatra::Base
+  Phaxio.callback_token = 'YOUR WEBHOOK TOKEN HERE'
+  
+  post '/webhook' do
     signature = request.env['HTTP_X_PHAXIO_SIGNATURE']
     url = request.url
-    file_params = params[:filename]
-    if Phaxio::Callback.valid_signature? signature, url, callback_params, file_params
+    file_params = params[:file]
+    if Phaxio::Callback.valid_signature? signature, url, webhook_params, file_params
       'Success'
     else
-      'Invalid callback signature'
+      'Invalid webhook signature'
     end
   end
 
-  def callback_params
+  def webhook_params
     params.select do |key, _value|
-      %w(success is_test direction fax metadata message).include?(key)
+      %w(success is_test direction fax metadata message event_type).include?(key)
+    end
+  end
+end
+```
+
+## Webhook Validation Example with Rails Controller
+
+``` ruby
+class WebhookController < ApplicationController
+  skip_before_action :verify_authenticity_token
+
+	def index
+    signature = request.headers['X-Phaxio-Signature']  
+    Phaxio.callback_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
+      Rails.logger.debug "Success"
+      render plain: 'Success'
+    else
+      Rails.logger.debug "Invalid callback signature"
+      render plain: 'Invalid callback signature'
+    end
+  end
+
+  def webhook_params 
+    params.permit(:success, :is_test, :direction, :fax, :metadata, :event_type, :message)
+  end
+
+  def file_params 
+    if params[:file]
+      [{ :name => 'file', :tempfile => params[:file].tempfile }]
     end
   end
 end

data/lib/phaxio.rb

@@ -1,3 +1,4 @@
+require 'base64'
 require 'json'
 require 'tempfile'
 require 'openssl'
@@ -16,7 +17,7 @@ Dir[File.expand_path(File.join('..', 'phaxio', 'helpers', '*.rb'), __FILE__)].ea
   require file
 end
 
-%w[fax_recipient fax account callback phax_code phone_number public].each do |filename|
+%w[fax_recipient fax account callback phax_code phone_number public ata].each do |filename|
   require File.expand_path(File.join('..', 'phaxio', 'resources', filename), __FILE__)
 end
 

data/lib/phaxio/client.rb

@@ -27,6 +27,7 @@ module Phaxio
         begin
           response = case method.to_s
                      when 'post' then post(endpoint, params)
+                     when 'patch' then patch(endpoint, params)
                      when 'get' then get(endpoint, params)
                      when 'delete' then delete(endpoint, params)
                      else raise ArgumentError, "HTTP method `#{method}` is not supported."
@@ -43,6 +44,10 @@ module Phaxio
           conn.request :multipart
           conn.request :url_encoded
           conn.adapter :net_http
+
+          if Phaxio.api_key && Phaxio.api_secret
+            conn.basic_auth Phaxio.api_key, Phaxio.api_secret
+          end
         end
       end
 
@@ -109,20 +114,35 @@ module Phaxio
           params[k] = file_param
         end
 
-        conn.post endpoint, params
+        conn.post endpoint, params, api_headers(params)
+      end
+
+      def patch endpoint, params = {}
+        # Handle file params
+        params.each do |k, v|
+          next unless k.to_s == 'file'
+
+          if v.is_a? Array
+            file_param = v.map { |file| file_to_param file }
+          else
+            file_param = file_to_param v
+          end
+
+          params[k] = file_param
+        end
+
+        conn.patch endpoint, params, api_headers(params)
       end
 
       def get endpoint, params = {}
-        conn.get endpoint, params
+        conn.get endpoint, params, api_headers(params)
       end
 
       def delete endpoint, params = {}
-        conn.delete endpoint, params
+        conn.delete endpoint, params, api_headers(params)
       end
 
       def api_params params
-        params = default_params.merge params
-
         # Convert times to ISO 8601
         params.each do |k, v|
           next unless v.kind_of?(Time) || v.kind_of?(Date)
@@ -132,11 +152,12 @@ module Phaxio
         params
       end
 
-      def default_params
-        {
-          api_key: Phaxio.api_key,
-          api_secret: Phaxio.api_secret
-        }
+      def api_headers params
+        api_key    = params[:api_key]    || Phaxio.api_key
+        api_secret = params[:api_secret] || Phaxio.api_secret
+        return unless api_key && api_secret
+        auth = Base64.strict_encode64("#{api_key}:#{api_secret}")
+        {'Authorization' => "Basic #{auth}"}
       end
 
       def file_to_param file

data/lib/phaxio/config.rb

@@ -1,6 +1,6 @@
 module Phaxio
   class Config
-    DEFAULT_API_ENDPOINT = 'https://api.phaxio.com/v2/'.freeze
+    DEFAULT_API_ENDPOINT = 'https://api.phaxio.com/v2.1/'.freeze
 
     class << self
       # Your Phaxio API key. This will be used for all interactions with the Phaxio API.

data/lib/phaxio/resources/ata.rb

@@ -0,0 +1,219 @@
+module Phaxio
+  module Resources
+    # Provides functionality for managing ATAs.
+    class Ata < Resource
+      ATAS_PATH = 'atas'.freeze
+      private_constant :ATAS_PATH
+
+      # @return [Integer] the ID of the ATA.
+      # @!attribute id
+
+      # @return [String] the name of the ATA.
+      # @!attribute name
+
+      # @return [String] the description of the ATA.
+      # @!attribute description
+
+      # @return [String] The user phone number associated with the ATA.
+      # @!attribute user_phone_number
+
+      # @return [String] The domain for the ATA.
+      # @!attribute domain
+
+      # @return [String] The username for the ATA.
+      # @!attribute uername
+
+      # @return [String] The password for the ATA.
+      # @!attribute password
+
+      has_normal_attributes %w[
+        id name description user_phone_number domain username password
+      ]
+
+      # A reference to an ATA. This is returned by certain actions which don't
+      # return the full ATA.
+      class Reference
+        # @return [Integer]
+        #   The ID of the referenced ATA.
+        attr_accessor :id
+
+        def to_i
+          id
+        end
+
+        private
+
+        def initialize id
+          self.id = id
+        end
+      end
+
+      # A reference to a phone number, returned by ATA phone number management
+      # actions.
+      class PhoneNumberReference
+        # @return [String]
+        #   The phone number.
+        attr_accessor :phone_number
+
+        def to_s
+          phone_number
+        end
+
+        private
+
+        def initialize phone_number
+          self.phone_number = phone_number
+        end
+      end
+
+      class << self
+        # @macro paging
+        # List ATAs
+        # @param params[Hash]
+        #   Any parameters to send to Phaxio.
+        # @return [Phaxio::Resource::Collection<Phaxio::Resources::Ata>]
+        #   The collection of ATAs matching your request.
+        # @raise [Phaxio::Error::PhaxioError]
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/list
+        def list params = {}
+          response = Client.request :get, atas_endpoint, params
+          response_collection response
+        end
+
+        # Create an ATA
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio.
+        #   - *name* [String] - A name used to identify the ATA.
+        #   - *description* [String] - A longer description of the ATA.
+        #   - *domain* [String] - A domain for the ATA.
+        # @return [Phaxio::Resources::Ata]
+        #   The created ATA, including the generated username and password.
+        # @raise [Phaxio::Error::PhaxioError]
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/create
+        def create params = {}
+          response = Client.request :post, atas_endpoint, params
+          response_record response
+        end
+
+        # Get an ATA
+        # @param id [Integer]
+        #   The ID of the ATA to retrieve information about.
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio. This action takes no unique parameters.
+        # @return [Phaxio::Resources::Ata]
+        #   The requested ATA.
+        # @raise [Phaxio::Error::PhaxioError]
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/get
+        def get id, params = {}
+          response = Client.request :get, ata_endpoint(id.to_i), params
+          response_record response
+        end
+        alias :retrieve :get
+        alias :find :get
+
+        # Update an ATA
+        # @param id [Integer]
+        #   The ID of the ATA to update.
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio.
+        #   - *name* [String] - A name used to identify the ATA.
+        #   - *description* [String] - A longer description of the ATA.
+        #   - *domain* [String] - A domain for the ATA.
+        # @return [Phaxio::Resources::Ata]
+        #   The updated ATA.
+        # @raise [Phaxio::Error::PhaxioError]
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/update
+        def update id, params = {}
+          response = Client.request :patch, ata_endpoint(id.to_i), params
+          response_record response
+        end
+
+        # Regenerate credentials for an ATA
+        # @param id [Integer]
+        #   The ID of the ATA for which credentials should be regenerated.
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio. This action takes no unique parameters.
+        # @return [Phaxio::Resources::Ata]
+        #   The ATA, including the new username and password.
+        # @raise Phaxio::Error::PhaxioError
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/regenerate_credentials
+        def regenerate_credentials id, params = {}
+          response = Client.request :patch, regenerate_credentials_endpoint(id.to_i), params
+          response_record response
+        end
+
+        # Delete an ATA
+        # @param id [Integer]
+        #   The Id of the ATA to delete.
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio. This action takes no unique parameters.
+        # @return [Phaxio::Resources::Ata::Reference]
+        #   A reference to the deleted ATA.
+        # @raise [Phaxio::Error::PhaxioError]
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/delete
+        def delete id, params = {}
+          response = Client.request :delete, ata_endpoint(id.to_i), params
+          response_reference response
+        end
+
+        # Add a phone number
+        # @param id [Integer]
+        #   The ID of the ATA to which you want to add a number.
+        # @param phone_number [String]
+        #   The phone number to add to the ATA.
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio. This action takes no unique parameters.
+        # @return [Phaxio::Resources::Ata::PhoneNumberReference]
+        #   A reference to the added phone number.
+        # @raise [Phaxio::Error::PhaxioError]
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/add_phone_number
+        def add_phone_number id, phone_number, params = {}
+          response = Client.request :post, phone_number_endpoint(id, phone_number), params
+          response_phone_number_reference response
+        end
+
+        # Remove a phone number
+        # @param id [Integer]
+        #   The ID of the ATA from which you want to remove the phone number.
+        # @param phone_number [String]
+        #   The phone number you want to remove.
+        # @param params [Hash]
+        #   Any parameters to send to Phaxio. This action takes no unique parameters.
+        # @return [Phaxio::Resources::Ata::PhoneNumberReference]
+        #   A reference to the removed phone number.
+        # @raise [Phaxio::Error::PhaxioError]
+        # @see https://www.phaxio.com/docs/api/v2.1/atas/remove_phone_number
+        def remove_phone_number id, phone_number, params = {}
+          response = Client.request :delete, phone_number_endpoint(id, phone_number), params
+          response_phone_number_reference response
+        end
+
+        private
+
+        def response_reference response
+          Reference.new Integer(response['id'])
+        end
+
+        def response_phone_number_reference response
+          PhoneNumberReference.new(response['phone_number'])
+        end
+
+        def atas_endpoint
+          ATAS_PATH
+        end
+
+        def ata_endpoint id
+          "#{atas_endpoint}/#{id}"
+        end
+
+        def regenerate_credentials_endpoint id
+          "#{ata_endpoint(id)}/regenerate_credentials"
+        end
+
+        def phone_number_endpoint id, phone_number
+          "#{ata_endpoint(id)}/phone_numbers/#{phone_number}"
+        end
+      end
+    end
+  end
+end

data/lib/phaxio/version.rb

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

data/phaxio.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.licenses      = ['MIT']
 
   gem.required_ruby_version = '>= 2.0'
-  gem.add_dependency 'faraday', '~> 0.10'
+  gem.add_dependency 'faraday', '>= 0.10', '< 2.0'
   gem.add_dependency 'mime-types', '~> 3.0'
   gem.add_dependency 'activesupport'
 end

data/spec/client_spec.rb

@@ -65,9 +65,9 @@ RSpec.describe Phaxio::Client do
     end
 
     it 'uses the configured API key and secret by default' do
-      expect(test_connection).to receive(:get) do |_endpoint, request_params|
-        expect(request_params[:api_key]).to eq(Phaxio.api_key)
-        expect(request_params[:api_secret]).to eq(Phaxio.api_secret)
+      expect(test_connection).to receive(:get) do |_endpoint, _request_params, request_headers|
+        auth_header = "Basic #{Base64.strict_encode64("#{Phaxio.api_key}:#{Phaxio.api_secret}")}"
+        expect(request_headers['Authorization']).to eq(auth_header)
         test_response 200
       end
       client.request :get, 'test'
@@ -76,9 +76,9 @@ RSpec.describe Phaxio::Client do
     it 'uses the api key specified in the params hash' do
       custom_api_key = 'custom-api-key'
       custom_api_secret = 'custom-api-secret'
-      expect(test_connection).to receive(:get) do |_endpoint, request_params|
-        expect(request_params[:api_key]).to eq(custom_api_key)
-        expect(request_params[:api_secret]).to eq(custom_api_secret)
+      expect(test_connection).to receive(:get) do |_endpoint, _request_params, request_headers|
+        auth_header = "Basic #{Base64.strict_encode64('custom-api-key:custom-api-secret')}"
+        expect(request_headers['Authorization']).to eq(auth_header)
         test_response 200
       end
       client.request :get, 'test', api_key: custom_api_key, api_secret: custom_api_secret