<commit_before># Phaxio

A Ruby gem for interacting with the [Phaxio API]( https://www.phaxio.com/docs ).



## 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: "test.pdf")

### Currently Supported API Calls

* send_fax - `Phaxio.send_fax(to: "0123456789", filename: "test.pdf")`
* test_receive - `Phaxio.test_receive(filename: "test_file.pdf")`
* get_fax_status - `Phaxio.get_fax_status(id: "123456")`
* cancel_fax - `Phaxio.cancel_fax(id: "123456")`
* get_account_status - `Phaxio.get_account_status`

## 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'`)<commit_msg>add a decent example to the README<commit_after># Phaxio

A Ruby gem for interacting with the [Phaxio API]( https://www.phaxio.com/docs ).



## 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: "test.pdf")

### Currently Supported API Calls

* send_fax - `Phaxio.send_fax(to: "0123456789", filename: "test.pdf")`
* test_receive - `Phaxio.test_receive(filename: "test_file.pdf")`
* get_fax_status - `Phaxio.get_fax_status(id: "123456")`
* cancel_fax - `Phaxio.cancel_fax(id: "123456")`
* 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"])

## 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'`)
{'fraction_non_alphanumeric': 0.12143161482743929, 'fraction_numerical': 0.05325948018747337, 'mean_word_length': 3.9018789144050103, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 1, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5571707', 'n_tokens_mistral': 968, 'n_tokens_neox': 834, 'n_words': 226}