Ruby Gem for Phaxio API
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
test
.gitignore
.ruby-version
.travis.yml
Gemfile
LICENSE
README.md
Rakefile
phaxio.gemspec

README.md

Phaxio

Build Status

A Ruby gem for interacting with the Phaxio API.

Note: This gem only runs on Ruby version 1.9.+

Installation

Add this line to your application's Gemfile:

gem 'phaxio'

And then execute:

$ bundle

Or install it yourself as:

$ gem install phaxio

Usage

Configure Phaxio with your api_key and api_secret:

Phaxio.config do |config|
  config.api_key = "10987654321"
  config.api_secret = "12345678910"
end

To send a fax:

Phaxio.send_fax(to: "0123456789", filename: File.new("test.pdf"))

Currently Supported API Calls

  • send_fax - Phaxio.send_fax(to: "0123456789", filename: File.new("test.pdf"))
  • resend_fax - Phaxio.resend_fax(id: 1234)
  • test_receive - Phaxio.test_receive(filename: "test_file.pdf")
  • provision_number - Phaxio.provision_number(area_code: 802)
  • release_number - Phaxio.release_number(number: "8021112222")
  • list_numbers - Phaxio.list_numbers(area_code: 802)
  • get_fax_file - Phaxio.get_fax_file(id: 123456, type: p)
  • list_faxes - Phaxio.list_numbers(area_code: 802)
  • list_faxes - Phaxio.list_faxes(start: Time.now - 48000, end: Time.now)
  • get_fax_status - Phaxio.get_fax_status(id: 123456)
  • cancel_fax - Phaxio.cancel_fax(id: 123456)
  • delete_fax - Phaxio.delete_fax(id: 1234, files_only: true)
  • get_account_status - Phaxio.get_account_status

Example

require 'phaxio'

Phaxio.config do |config|
  config.api_key = "your_key"
  config.api_secret = "your_secret"
end

@fax = Phaxio.send_fax(to: '15555555555', string_data: "hello world")
Phaxio.get_fax_status(id: @fax["faxId"])

# Get a Fax and save it as a PDF
@pdf = Phaxio.get_fax_file(id: @fax["faxId"], type: "p")
File.open("received_test.pdf", "w") do |file|
  file << @pdf
end

Callback Validation Example with Sinatra

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
    if Phaxio.valid_callback_signature?(
      request.env['HTTP_X_PHAXIO_SIGNATURE'],
      request.url, callback_params, params[:filename])
      'Success'
    else
      'Invalid callback signature'
    end
  end

  def callback_params
    params.select do |key, _value|
      %w(success is_test direction fax metadata message).include?(key)
    end
  end
end

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request