faxage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9bf0a54daaaf950f2b5ad56aeafc9e81b6097cdba4a76ca7db165b07ae91e40d
+  data.tar.gz: bb3ee8132869fbf8216e190c837390926ab87457418d69cb8051b43a4bde056f
+SHA512:
+  metadata.gz: 9ce41be4d2b5e2d70f32d511c4084e07b2ba5d8deeafb4ba65e6c5161a33c1bdb5d4c51876879c097ff913baaa3e2c8eea4f27cec3ba3c9edbb09d0f9496e0fd
+  data.tar.gz: 26bb746a3c90321dc3316c7eb51d6fb9b2a36d82ae1516210df56e55ca7dc95bb7614f0c434aaa906b20397cf12dde32c24c36438451fbb11b04eba945ebbb82

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at diasks2@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in faxage.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    faxage (0.1.0)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httparty (0.18.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  faxage!
+  rake (>= 12.3.3)
+  rspec (>= 3.4)
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Kevin Dias
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+# Faxage
+
+Faxage is a Ruby wrapper for the [faxage.com](https://www.faxage.com/internet-fax-api.php) API.
+
+The Faxage API can be used to send and receive faxes, gather sent fax images and transmittal pages, provision DIDs, enable and disable (busy out) DIDs, access CDRs, get realtime status, can be polled or can push sent and received fax notifications, check local number portability, manage users, retrieve system audit logs and more.
+
+The author of this gem is not affliated with Faxage. The Faxage API docs can be found [here](https://www.faxage.com/docdl.php?docid=6).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faxage'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faxage
+
+## Usage
+
+#### Supported File Types
+
+As of this writing, the following file types are supported for sending, others may become
+available over time, so please check with us if the type of content you wish to send is not
+listed here. An automatically updated list (based on what FAXAGE is configured to
+support) is available at the following URL: http://www.faxage.com/learn_faxage_send_faxes_email_website_api.php
+
+Click the link for ‘Q: What types of files can I send?’ on the above URL to get the list.
+
+| Description                          | Extension(s) |
+|--------------------------------------|--------------|
+| Adobe PDF                            | PDF          |
+| Adobe PostScript                     | PS           |
+| Microsoft Word                       | DOC or DOCX  |
+| Microsoft Word Template              | DOT          |
+| Microsoft Works                      | WPS          |
+| WordPerfect                          | WPD          |
+| OpenOffice / LibreOffice Document    | ODT          |
+| Rich Text                            | RTF          |
+| Microsoft Excel                      | XLS or XLSX  |
+| Microsoft Powerpoint                 | PPT or PPTX  |
+| OpenOffice / LibreOffice Spreadsheet | ODS          |
+| Comma-separated CSV                  | CSV          |
+| HTML                                 | HTM, HTML    |
+| Bitmap Image                         | BMP          |
+| GIF Image                            | GIF          |
+| JPEG Image                           | JPG, JPEG    |
+| TIFF Image                           | TIF, TIFF    |
+| PNG Image                            | PNG          |
+| HP Printer Control Language          | PCL          |
+| Plain Text                           | TXT          |
+
+#### Sending a fax
+```ruby
+Faxage::SendFax.new(
+  username: # Assigned FAXAGE username
+  company: # Assigned FAXAGE company credential
+  password: # Assigned FAXAGE password
+  recipname: # Recipient Name – 32 characters max
+  faxno: # Fax Number – 10 digits, numeric only
+  faxfilenames: # Array of file names. These must end in a
+  # supported extension – see the table above for a list
+  faxfiledata: # Corresponding array of base64-encoded strings that are the
+  # contents/data of the file in faxfilenames. E.g.: if faxfilenames[0] is
+  # test.doc, then faxfiledata[0] should be the base64-encoded contents
+  # of test.doc
+  debug: # A debugging URL is also provided that is equivalent to
+  # the httpsfax.php URL, except that
+  # it also returns the contents of your POST:
+  # Note that the debugging URL is still live and identical to the
+  # regular/production URL.
+  # For example, if you send a fax using the sendfax operation with
+  # the debugging URL, the fax will still get sent as normal.
+).send_fax()
+```
+#### Information Gathering Operations
+
+These operations relate to gathering information that helps with managing and/or
+monitoring your overall FAXAGE account.
+
+##### handlecount
+This operation allows you to see how many incoming faxes are stored within FAXAGE and, of those, how many you have marked as handled using the handled operation.
+
+```ruby
+Faxage::InformationGathering.new(
+  username: # Assigned FAXAGE username
+  company: # Assigned FAXAGE company credential
+  password: # Assigned FAXAGE password
+).handlecount
+
+# Example response:
+# {
+#   total_count: 10,
+#   handled_count: 5
+# }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/diasks2/faxage. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Faxage project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/diasks2/faxage/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faxage"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faxage.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "faxage/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "faxage"
+  spec.version       = Faxage::VERSION
+  spec.authors       = ["Kevin Dias"]
+  spec.email         = ["diasks2@gmail.com"]
+
+  spec.summary       = %q{Faxage is a Ruby wrapper for the faxage.com API}
+  spec.description   = %q{The Faxage API can be used to send and receive faxes, gather sent fax images and transmittal pages, provision DIDs, enable and disable (busy out) DIDs, access CDRs, get realtime status, can be polled or can push sent and received fax notifications, check local number portability, manage users, retrieve system audit logs and more.}
+  spec.homepage      = "https://github.com/diasks2/faxage"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", ">= 3.4"
+  spec.add_runtime_dependency "httparty"
+end

data/lib/faxage.rb

@@ -0,0 +1,3 @@
+require "faxage/version"
+require "faxage/send_fax"
+require "faxage/information_gathering"

data/lib/faxage/information_gathering.rb

@@ -0,0 +1,308 @@
+require 'httparty'
+
+module Faxage
+  class LoginError < StandardError
+  end
+
+  class FaxageInternalError < StandardError
+  end
+
+  class UnknownOperationError < StandardError
+  end
+
+  class NoResponseError < StandardError
+  end
+
+  class InformationGathering
+    include HTTParty
+    base_uri "https://api.faxage.com"
+
+    attr_reader :username, # Assigned FAXAGE username
+                :company, # Assigned FAXAGE company credential
+                :password # Assigned FAXAGE password
+    def initialize(username:, company:, password:)
+      @username = username
+      @company = company
+      @password = password
+    end
+
+    def handlecount
+      # This operation allows you to see how many incoming faxes are stored within FAXAGE
+      # and, of those, how many you have marked as handled using the handled operation.
+      subdirectory = "/httpsfax.php"
+
+      body = {
+        operation: "handlecount",
+        username: username,
+        company: company,
+        password: password
+      }
+
+      response = self.class.post(subdirectory,
+        body: body
+      )
+
+      if response.parsed_response.nil?
+        raise NoResponseError.new("An empty response was returned from Faxage.")
+      elsif response.parsed_response.include?("ERR02: Login incorrect")
+        raise LoginError.new("One or more of username, company, password is incorrect or your account is disabled for some reason.")
+      elsif response.parsed_response.include?("ERR01: Database connection failed")
+        raise FaxageInternalError.new("Internal FAXAGE error.")
+      elsif response.parsed_response.include?("ERR08: Unknown operation")
+        raise UnknownOperationError.new("Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes.")
+      else
+        parsed_response = response.parsed_response.gsub("\n", "").split("~")
+        data = {
+          total_count: parsed_response[0].to_i,
+          handled_count: parsed_response[1].to_i
+        }
+        return data
+      end
+    end
+
+    def pendcount
+      # This operation allows you to see how many outgoing faxes are currently pending to be
+      # sent on your FAXAGE account.
+
+      subdirectory = "/httpsfax.php"
+
+      body = {
+        operation: "pendcount",
+        username: username,
+        company: company,
+        password: password
+      }
+
+      response = self.class.post(subdirectory,
+        body: body
+      )
+
+      if response.parsed_response.nil?
+        raise NoResponseError.new("An empty response was returned from Faxage.")
+      elsif response.parsed_response.include?("ERR02: Login incorrect")
+        raise LoginError.new("One or more of username, company, password is incorrect or your account is disabled for some reason.")
+      elsif response.parsed_response.include?("ERR01: Database connection failed")
+        raise FaxageInternalError.new("Internal FAXAGE error.")
+      elsif response.parsed_response.include?("ERR08: Unknown operation")
+        raise UnknownOperationError.new("Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes.")
+      else
+        parsed_response = response.parsed_response.gsub("\n", "").to_i
+        data = {
+          pending_count: parsed_response
+        }
+        return data
+      end
+    end
+
+    def qstatus
+      # This operation allows you to gather details about how your outgoing pending faxes are
+      # currently queued. When you have more than one line on your FAXAGE account, the
+      # system automatically load-levels outgoing faxes across however many lines you have.
+      # Using this operation, you can see all of your pending outgoing faxes and which line(s)
+      # they are queued on, in order to analyze how your outgoing traffic is being distributed for
+      # sending by FAXAGE.
+      subdirectory = "/httpsfax.php"
+
+      body = {
+        operation: "qstatus",
+        username: username,
+        company: company,
+        password: password
+      }
+
+      response = self.class.post(subdirectory,
+        body: body
+      )
+
+      if response.parsed_response.nil?
+        raise NoResponseError.new("An empty response was returned from Faxage.")
+      elsif response.parsed_response.include?("ERR02: Login incorrect")
+        raise LoginError.new("One or more of username, company, password is incorrect or your account is disabled for some reason.")
+      elsif response.parsed_response.include?("ERR01: Database connection failed")
+        raise FaxageInternalError.new("Internal FAXAGE error.")
+      elsif response.parsed_response.include?("ERR08: Unknown operation")
+        raise UnknownOperationError.new("Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes.")
+      else
+        # TODO - parse response
+
+        # New-line separated records, as follows:
+        # <jobid><tab><callerID><tab><destination><tab><lineid
+        # ><tab><pagecount>
+        # See qstatus record definition below.
+
+        # CallerID – The caller ID you have requested when making the sendfax request, or your
+        # account’s default if you do not set separate caller ID’s for outgoing faxes
+        # Destination – The destination fax number for this outgoing fax
+        # LineID – Unique numeric ‘line’ ID. If you see more than one fax with the same LineID,
+        # that means FAXAGE has queued those faxes to the same line to be sent and one will
+        # have to wait for the other to finish before it will dial
+        # Pagecount – The number of pages associated with a given fax
+        return response.parsed_response
+      end
+    end
+
+    def incomingcalls
+      # This operation allows you to see how many incoming calls are currently in progress to
+      # your account and how many maximum total simultaneous calls your account is currently
+      # configured to allow without sending a busy signal.
+
+      subdirectory = "/httpsfax.php"
+
+      body = {
+        operation: "incomingcalls",
+        username: username,
+        company: company,
+        password: password
+      }
+
+      response = self.class.post(subdirectory,
+        body: body
+      )
+
+      if response.parsed_response.nil?
+        raise NoResponseError.new("An empty response was returned from Faxage.")
+      elsif response.parsed_response.include?("ERR02: Login incorrect")
+        raise LoginError.new("One or more of username, company, password is incorrect or your account is disabled for some reason.")
+      elsif response.parsed_response.include?("ERR01: Database connection failed")
+        raise FaxageInternalError.new("Internal FAXAGE error.")
+      elsif response.parsed_response.include?("ERR08: Unknown operation")
+        raise UnknownOperationError.new("Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes.")
+      else
+        parsed_response = response.parsed_response.gsub("\n", "").split("~")
+        data = {
+          incoming_count: parsed_response[0].to_i,
+          allocated_count: parsed_response[1].to_i
+        }
+        return data
+      end
+    end
+
+    def busycalls
+      # This operation allows you to see incoming calls that have experienced a busy signal
+      # because more calls were in progress at the time the call came than your account was
+      # configured to support.
+
+      subdirectory = "/httpsfax.php"
+
+      body = {
+        operation: "busycalls",
+        username: username,
+        company: company,
+        password: password
+      }
+
+      response = self.class.post(subdirectory,
+        body: body
+      )
+
+      if response.parsed_response.nil?
+        raise NoResponseError.new("An empty response was returned from Faxage.")
+      elsif response.parsed_response.include?("ERR02: Login incorrect")
+        raise LoginError.new("One or more of username, company, password is incorrect or your account is disabled for some reason.")
+      elsif response.parsed_response.include?("ERR01: Database connection failed")
+        raise FaxageInternalError.new("Internal FAXAGE error.")
+      elsif response.parsed_response.include?("ERR08: Unknown operation")
+        raise UnknownOperationError.new("Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes.")
+      else
+        # TODO - parse response
+
+        # New-line separated records, formatted as follows:
+        # <number-called><tab><number-calling><tab><time>
+        # Where:
+        # Number-called – Your number that was called
+        # Number-calling – The Caller ID for the caller
+        # Time – YYYY-MM-DD HH:MM:SS format
+
+        return response.parsed_response
+      end
+    end
+
+    def portstatus
+      # This operation allows you to see the status of port requests you have in progress or that
+      # have been completed with FAXAGE.
+
+      subdirectory = "/httpsfax.php"
+
+      body = {
+        operation: "portstatus",
+        username: username,
+        company: company,
+        password: password
+      }
+
+      response = self.class.post(subdirectory,
+        body: body
+      )
+
+      if response.parsed_response.nil?
+        raise NoResponseError.new("An empty response was returned from Faxage.")
+      elsif response.parsed_response.include?("ERR02: Login incorrect")
+        raise LoginError.new("One or more of username, company, password is incorrect or your account is disabled for some reason.")
+      elsif response.parsed_response.include?("ERR01: Database connection failed")
+        raise FaxageInternalError.new("Internal FAXAGE error.")
+      elsif response.parsed_response.include?("ERR08: Unknown operation")
+        raise UnknownOperationError.new("Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes.")
+      else
+        # TODO - parse response
+
+        # New-line separated records, formatted as follows:
+        # <number><tab><request-date><tab><duedate><tab><completedate><tab><status><tab><comment><tab><complete>
+        # Where:
+        # Number – The number you are porting
+        # Request-date – YYYY-MM-DD date of request
+        # Due-date – YYYY-MM-DD expected completion date
+        # Complete-date – YYYY-MM-DD date actually
+        # completed 0000-00-00 for requests in progress
+        # Status – One of ‘Initial’, ‘SOA PEND’, ‘Reject’,
+        # ‘Completed’ or ‘Canceled’. SOA PEND means the
+        # carrier has accepted for completion on the Due-date
+        # Comment – Free-form comment about the current
+        # status. FAXAGE staff enters these as ports are worked
+        # Complete – Yes or No
+
+        return response.parsed_response
+      end
+    end
+
+    def auditlog(**options)
+      # This operation allows you to retrieve audit logs for your FAXAGE account. The
+      # FAXAGE auditing system is a comprehensive system that keeps a trail of all activities
+      # within your account. See the FAXAGE Internet Fax Auditing Documentation for details
+      # as to the structure of audit logs and what data is contained within each type of auditable
+      # operation.
+
+      subdirectory = "/httpsfax.php"
+
+      body = {
+        operation: "auditlog",
+        username: username,
+        company: company,
+        password: password
+      }.merge!(options)
+
+      response = self.class.post(subdirectory,
+        body: body
+      )
+
+      if response.parsed_response.nil?
+        raise NoResponseError.new("An empty response was returned from Faxage.")
+      elsif response.parsed_response.include?("ERR02: Login incorrect")
+        raise LoginError.new("One or more of username, company, password is incorrect or your account is disabled for some reason.")
+      elsif response.parsed_response.include?("ERR01: Database connection failed")
+        raise FaxageInternalError.new("Internal FAXAGE error.")
+      elsif response.parsed_response.include?("ERR08: Unknown operation")
+        raise UnknownOperationError.new("Either operation is not correctly hard coded or the POST was bad, the POST contents are returned for debugging purposes.")
+      else
+        # TODO - parse response
+
+        # <audit-id><tab><timestamp><tab><login><tab><ipaddress><tab><interface><tab><web
+        # sessid><tab><auditop><tab><opstat><tab><requestdetail><tab><response-detail>
+        # Each of the above fields is defined in detail in the
+        # Internet Fax Auditing Documentation as previously
+        # noted
+
+        return response.parsed_response
+      end
+    end
+  end
+end

data/lib/faxage/send_fax.rb

@@ -0,0 +1,60 @@
+require 'httparty'
+
+module Faxage
+  class SendFax
+    include HTTParty
+    base_uri "https://api.faxage.com"
+
+    attr_reader :username, # Assigned FAXAGE username
+                :company, # Assigned FAXAGE company credential
+                :password, # Assigned FAXAGE password
+                :recipname, # Recipient Name – 32 characters max
+                :faxno, # Fax Number – 10 digits, numeric only
+                :faxfilenames, # Array of file names. These must end in a
+                # supported extension – see the table in the README for a list
+                :faxfiledata, # Corresponding array of base64-encoded strings that are the
+                # contents/data of the file in faxfilenames. E.g.: if faxfilenames[0] is
+                # test.doc, then faxfiledata[0] should be the base64-encoded contents
+                # of test.doc
+                :debug # A debugging URL is also provided that is equivalent to
+                # the httpsfax.php URL, except that
+                # it also returns the contents of your POST:
+                # Note that the debugging URL is still live and identical to the
+                # regular/production URL.
+                # For example, if you send a fax using the sendfax operation with
+                # the debugging URL, the fax will still get sent as normal.
+    def initialize(username:, company:, password:, recipname:, faxno:, faxfilenames:, faxfiledata:, debug:)
+      @username = username
+      @company = company
+      @password = password
+      @recipname = recipname
+      @faxno = faxno
+      @faxfilenames = faxfilenames
+      @faxfiledata = faxfiledata
+      @debug = debug
+    end
+
+    def send_fax(**options)
+      if debug
+        subdirectory = "/httpsfax-debug.php"
+      else
+        subdirectory = "/httpsfax.php"
+      end
+
+      body = {
+        operation: "sendfax",
+        username: username,
+        company: company,
+        password: password,
+        recipname: recipname,
+        faxno: faxno,
+        faxfilenames: faxfilenames,
+        faxfiledata: faxfiledata
+      }.merge!(options)
+
+      self.class.post(subdirectory,
+        body: body
+      )
+    end
+  end
+end

data/lib/faxage/version.rb

@@ -0,0 +1,3 @@
+module Faxage
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: faxage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Dias
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Faxage API can be used to send and receive faxes, gather sent fax
+  images and transmittal pages, provision DIDs, enable and disable (busy out) DIDs,
+  access CDRs, get realtime status, can be polled or can push sent and received fax
+  notifications, check local number portability, manage users, retrieve system audit
+  logs and more.
+email:
+- diasks2@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faxage.gemspec
+- lib/faxage.rb
+- lib/faxage/information_gathering.rb
+- lib/faxage/send_fax.rb
+- lib/faxage/version.rb
+homepage: https://github.com/diasks2/faxage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Faxage is a Ruby wrapper for the faxage.com API
+test_files: []