phaxio 0.1.0 → 0.2.0

data/README.md

@@ -20,24 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-Configure a client with an api_key and api_secret:
+Configure Phaxio with your api_key and api_secret:
 
-    @client = Phaxio.client.config do |config|
-      config.api_key = 10987654321
-      config.api_secret = 12345678910
+    Phaxio.config do |config|
+      config.api_key = "10987654321"
+      config.api_secret = "12345678910"
     end
 
-Send a fax:
+To send a fax:
 
-    @client.send_fax(to: "0123456789", filename: "test.pdf")
+    Phaxio.send_fax(to: "0123456789", filename: "test.pdf")
 
 ### Currently Supported API Calls
 
-* send_fax
-* test_receive
-* get_fax_status
-* cancel_fax
-* get_account_status
+* 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
 

data/lib/phaxio/client.rb

@@ -1,30 +1,12 @@
 module Phaxio
+  include  HTTParty
+  base_uri 'https://api.phaxio.com/v1'
+
   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
-
+  module Client
     # Public: Send a fax.
     #
     # options - The Hash options used to refine the selection (default: {}):
@@ -76,11 +58,15 @@ module Phaxio
     #                                        completed. Must be between 1 and 60
     #                                        (optional).
     #
+    # Examples
+    #
+    #   Phaxio.send_fax(to: "0123456789", filename: "test.pdf")
+    #
     # 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)
+      send_post("/send", options)
     end
 
     # Public: Test receiving a fax.
@@ -93,11 +79,15 @@ module Phaxio
     #                         a PhaxCode and is the file you want to simulate
     #                         sending (required).
     #
+    # Examples
+    #
+    #   Phaxio.test_receive(filename: "test_file.pdf")
+    #
     # 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)
+      send_post("/testReceive", options)
     end
 
     # Public: Get the status of a specific fax.
@@ -106,15 +96,19 @@ module Phaxio
     #           id - The int id of the fax you want to get the status of
     #                (required).
     #
+    # Examples
+    #
+    #   Phaxio.get_fax_status(id: "123456")
+    #
     # 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)
+      send_post("/faxStatus", options)
     end
 
     # Public: Cancel a specific fax.
@@ -122,24 +116,48 @@ module Phaxio
     # options - The Hash options used to refine the selection (defaults: {}):
     #           id - The int id of the fax you want to cancel (required).
     #
+    # Examples
+    #
+    #   Phaxio.cancel_fax(id: "123456")
+    #
     # 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)
+      send_post("/faxCancel", options)
     end
 
     # Public: Get the status of Client's account.
     #
+    # Examples
+    #
+    #   Phaxio.get_account_status
+    #
     # 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 })
+      send_post("/accountStatus", {})
+    end
+
+    def send_post(path, options)
+      post(path, options.merge!({api_key: api_key, api_secret: api_secret}))
     end
   end
 
-  def self.client
-    @client ||= Client.new
+  # Public: Configure Phaxio with your api_key and api_secret
+  #
+  # Examples
+  #
+  #   Phaxio.config do |config|
+  #      config.api_key = "12345678910"
+  #      config.api_secret = "10987654321"
+  #    end
+  #
+  # Returns nothing.
+  def self.config
+    yield(self)
   end
 
+  extend Client
+  extend Config
 end

data/lib/phaxio/version.rb

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

data/phaxio.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |gem|
 
   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"
+  gem.add_development_dependency  "rake",       "~> 0.9.2.2"
 end

data/test/test_phaxio.rb

@@ -2,48 +2,47 @@ 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
+    Phaxio.config do |config|
+      config.api_key = "12345678910"
+      config.api_secret = "10987654321"
     end
   end
 
   def test_config
-    assert_equal 10987654321, @client.api_key
-    assert_equal 12345678910, @client.api_secret
+    assert_equal "12345678910", Phaxio.api_key
+    assert_equal "10987654321", Phaxio.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")
+    @response = Phaxio.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")
+    @response = Phaxio.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")
+    @response = Phaxio.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")
+    @response = Phaxio.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
+    @response = Phaxio.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"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phaxio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors: