phaxio 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem "fakeweb", "~> 1.3.0"
+gem "httparty", "~> 0.9.0"
+gem "rake", "~> 0.9.2.2"
+
+# Specify your gem's dependencies in phaxio.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gristmill
+
+MIT License
+
+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,48 @@
+# 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 a client with an api_key and api_secret:
+
+    @client = Phaxio.client.config do |config|
+      config.api_key = 10987654321
+      config.api_secret = 12345678910
+    end
+
+Send a fax:
+
+    @client.send_fax(to: "0123456789", filename: "test.pdf")
+
+### Currently Supported API Calls
+
+* send_fax
+* test_receive
+* get_fax_status
+* cancel_fax
+* 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'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/phaxio.rb

@@ -0,0 +1,4 @@
+require "httparty"
+
+require "phaxio/version"
+require "phaxio/client"

data/lib/phaxio/client.rb

@@ -0,0 +1,145 @@
+module Phaxio
+  module Config
+    attr_accessor :api_key, :api_secret
+  end
+
+  class Client
+    include  HTTParty
+    base_uri 'https://api.phaxio.com/v1'
+
+    # Public: Initialize a new Client.
+    #
+    # Returns nothing.
+    def initialize
+      extend(Config)
+    end
+
+    # Public: Configure a Client.
+    #
+    # Returns the Client.
+    def config
+      if block_given?
+        yield(self)
+      end
+
+      self
+    end
+
+    # Public: Send a fax.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           :to                        - The Phone Number (i.e. [country
+    #                                        code][number] or just a 10 digit
+    #                                        number in the US or Canada). Put
+    #                                        square brackets after parameter
+    #                                        name to send to multiple
+    #                                        recipients (e.g. to[]) (required).
+    #           :filename                  - The Binary Stream name of the file
+    #                                        you want to fax. This is optional
+    #                                        if you specify string_data. Must
+    #                                        have file name in the filename
+    #                                        field of the body-part header. Put
+    #                                        square brackets after parameter
+    #                                        name to send multiple files (e.g.
+    #                                        filename[]) (required).
+    #           :string_data               - A String of html, plain text, or a
+    #                                        URL. If additional files are
+    #                                        specified as well, this data will
+    #                                        be included first in the fax
+    #                                        (optional).
+    #           :string_data_type          - An enum of the type of the string
+    #                                        data that can be 'html', 'url', or
+    #                                        'text'. If not specified, default
+    #                                        is 'text'. See string data
+    #                                        rendering for more info (optional).
+    #           :batch                     - The bool for running in batching
+    #                                        mode. If present and true, fax will
+    #                                        be sent in batching mode. Requires
+    #                                        batch_delay to be specified
+    #                                        (optional).
+    #           :batch_delay               - The int the of amount of time, in
+    #                                        seconds, before the batch is fired.
+    #                                        Must be specified if batch=true.
+    #                                        Maximum delay is 3600 (1 hour)
+    #                                        (optional).
+    #           :batch_collision_avoidance - The bool for collision avoidance
+    #                                        with batches. If true when
+    #                                        batch=true, fax will be blocked
+    #                                        until the receiving machine is no
+    #                                        longer busy (optional).
+    #           :callback_url              - The String url for the callback.
+    #                                        Overrides the globally set one
+    #                                        (optional).
+    #           :cancel_timeout            - An int of the number of minutes
+    #                                        after which the fax will be
+    #                                        canceled if it hasn't yet
+    #                                        completed. Must be between 1 and 60
+    #                                        (optional).
+    #
+    # Returns a HTTParty::Response object containing a success bool,
+    # a String message, and an in faxID.
+    def send_fax(options)
+      options.merge!({api_key: api_key, api_secret: api_secret})
+      self.class.post("/send", options)
+    end
+
+    # Public: Test receiving a fax.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           from_number - The Phone Number of the simulated sender
+    #                         (optional).
+    #           to_number   - The Phone Number receiving the fax (optional).
+    #           filename    - A String containing the name of the PDF that has
+    #                         a PhaxCode and is the file you want to simulate
+    #                         sending (required).
+    #
+    # Returns a HTTParty::Response object containing a success bool
+    # and a String message.
+    def test_receive(options)
+      options.merge!({api_key: api_key, api_secret: api_secret})
+      self.class.post("/testReceive", options)
+    end
+
+    # Public: Get the status of a specific fax.
+    #
+    # options - The Hash options used to refine the selection (default: {}):
+    #           id - The int id of the fax you want to get the status of
+    #                (required).
+    #
+    # Returns a HTTParty::Response object containing a success bool,
+    # a String message, and the data of the fax.
+    def get_fax_status(options)
+      if options[:id].nil?
+        raise StandardError, "You must include a fax id."
+      end
+      
+      options.merge!({api_key: api_key, api_secret: api_secret})
+      self.class.post("/faxStatus", options)
+    end
+
+    # Public: Cancel a specific fax.
+    #
+    # options - The Hash options used to refine the selection (defaults: {}):
+    #           id - The int id of the fax you want to cancel (required).
+    #
+    # Returns a HTTParty::Response object containing a success bool
+    # and a String message.
+    def cancel_fax(options)
+      options.merge!({api_key: api_key, api_secret: api_secret})
+      self.class.post("/faxCancel", options)
+    end
+
+    # Public: Get the status of Client's account.
+    #
+    # Returns a HTTParty::Response object with success, message, and data
+    # (containing faxes_sent_this_month, faxes_sent_today, and balance).
+    def get_account_status
+      self.class.post("/accountStatus", { api_key: api_key, api_secret:api_secret })
+    end
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+end

data/lib/phaxio/version.rb

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

data/phaxio.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/phaxio/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Sean Behan", "Brett Chalupa"]
+  gem.email         = ["inbox@seanbehan.com", "brettchalupa@gmail.com"]
+  gem.description   = %q{A Ruby Gem for interacting with Phaxio's JSON API}
+  gem.summary       = %q{A Ruby Gem for interacting with Phaxio's JSON API}
+  gem.homepage      = "http://gristmill.io"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "phaxio"
+  gem.require_paths = ["lib"]
+  gem.version       = Phaxio::VERSION
+
+  gem.add_runtime_dependency      "httparty",   "~> 0.9.0"
+  gem.add_development_dependency  "fakeweb",    "~> 1.3.0"
+  gem.add_development_dependency  "rake", "~> 0.9.2.2"
+end

data/test/support/account_status.json

@@ -0,0 +1,9 @@
+{
+    "success":true,
+    "message":"Account status retrieved successfully",
+    "data":{
+        "faxes_sent_this_month":120,
+        "faxes_sent_today":10,
+        "balance":3000
+    }
+}

data/test/support/responses/account_status.json

@@ -0,0 +1,9 @@
+{
+    "success":true,
+    "message":"Account status retrieved successfully",
+    "data":{
+        "faxes_sent_this_month":120,
+        "faxes_sent_today":10,
+        "balance":3000
+    }
+}

data/test/support/responses/cancel_success.json

@@ -0,0 +1,4 @@
+{
+    "success":true,
+    "message":"Fax canceled successfully."
+}

data/test/support/responses/fax_status_success.json

@@ -0,0 +1,21 @@
+{
+    "success":true,
+    "message":"Retrieved fax successfully",
+    "data":{
+        "id":123456,
+        "num_pages":3,
+        "cost":21,
+        "direction":"sent",
+        "status":"success",
+        "is_test":true,
+        "requested_at":1293910680,
+        "completed_at":1293911100,
+        "recipients":[
+{
+                "number":"4141234567",
+                "status":"success",
+                "completed_at":1293911100
+            }
+        ]
+    }
+}

data/test/support/responses/send_failure.json

@@ -0,0 +1,8 @@
+{
+    "success":false,
+    "message":"Fax not queued for sending",
+    "faxId":1234,
+    "data":{
+        "faxId":1234
+    }
+}

data/test/support/responses/send_success.json

@@ -0,0 +1,8 @@
+{
+    "success":true,
+    "message":"Fax queued for sending",
+    "faxId":1234,
+    "data":{
+        "faxId":1234
+    }
+}

data/test/support/responses/test_receive.json

@@ -0,0 +1,4 @@
+{
+    "success":true,
+    "message":"Test fax received from 234567890. Calling back now..."
+}

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+$:<<(".")
+require "test/unit"
+require "fakeweb"
+require "lib/phaxio"
+
+FakeWeb.register_uri(:post, "https://api.phaxio.com/v1/send",
+  :body         => File.open("test/support/responses/send_success.json").read,
+  :content_type => "application/json")
+
+FakeWeb.register_uri(:post, "https://api.phaxio.com/v1/testReceive",
+  :body         => File.open("test/support/responses/test_receive.json").read,
+  :content_type => "application/json")
+
+FakeWeb.register_uri(:post, "https://api.phaxio.com/v1/testReceive",
+  :body         => File.open("test/support/responses/test_receive.json").read,
+  :content_type => "application/json")
+
+FakeWeb.register_uri(:post, "https://api.phaxio.com/v1/faxStatus",
+  :body         => File.open("test/support/responses/fax_status_success.json").read,
+  :content_type => "application/json")
+
+FakeWeb.register_uri(:post, "https://api.phaxio.com/v1/faxCancel",
+  :body         => File.open("test/support/responses/cancel_success.json").read,
+  :content_type => "application/json")
+
+FakeWeb.register_uri(:post, "https://api.phaxio.com/v1/accountStatus",
+  :body         => File.open("test/support/responses/account_status.json").read,
+  :content_type => "application/json")

data/test/test_phaxio.rb

@@ -0,0 +1,51 @@
+require_relative "test_helper"
+
+class TestPhaxio < Test::Unit::TestCase
+  def setup
+    @client = Phaxio.client.config do |config|
+      config.api_key = 10987654321
+      config.api_secret = 12345678910
+    end
+  end
+
+  def test_config
+    assert_equal 10987654321, @client.api_key
+    assert_equal 12345678910, @client.api_secret
+  end
+
+  def test_initialize
+    assert_instance_of Phaxio::Client, @client
+  end
+
+  def test_send_fax
+    @response = @client.send_fax(to: "0123456789", filename: "test.pdf")
+    assert_equal true, @response["success"]
+    assert_equal "Fax queued for sending", @response["message"]
+    assert_equal 1234, @response["faxId"]
+  end
+
+  def test_test_receive
+    @response = @client.test_receive(filename: "test_file.pdf")
+    assert_equal true, @response["success"]
+    assert_equal "Test fax received from 234567890. Calling back now...", @response["message"]
+  end
+
+  def test_get_fax_status
+    @response = @client.get_fax_status(id: "123456")
+    assert_equal true, @response["success"]
+    assert_equal "Retrieved fax successfully", @response["message"]
+  end
+
+  def test_cancel_fax
+    @response = @client.cancel_fax(id: "123456")
+    assert_equal true, @response["success"]
+    assert_equal "Fax canceled successfully.", @response["message"]
+  end
+
+  def test_get_account_status
+    @response = @client.get_account_status
+    assert_equal true, @response["success"]
+    assert_equal "Account status retrieved successfully", @response["message"]
+    assert_equal 120, @response["data"]["faxes_sent_this_month"]
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: phaxio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sean Behan
+- Brett Chalupa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+description: A Ruby Gem for interacting with Phaxio's JSON API
+email:
+- inbox@seanbehan.com
+- brettchalupa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/phaxio.rb
+- lib/phaxio/client.rb
+- lib/phaxio/version.rb
+- phaxio.gemspec
+- test/support/account_status.json
+- test/support/responses/account_status.json
+- test/support/responses/cancel_success.json
+- test/support/responses/fax_status_success.json
+- test/support/responses/send_failure.json
+- test/support/responses/send_success.json
+- test/support/responses/test_receive.json
+- test/test_helper.rb
+- test/test_phaxio.rb
+homepage: http://gristmill.io
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Ruby Gem for interacting with Phaxio's JSON API
+test_files:
+- test/support/account_status.json
+- test/support/responses/account_status.json
+- test/support/responses/cancel_success.json
+- test/support/responses/fax_status_success.json
+- test/support/responses/send_failure.json
+- test/support/responses/send_success.json
+- test/support/responses/test_receive.json
+- test/test_helper.rb
+- test/test_phaxio.rb