sr_fax 0.4.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e48956c74b31f3de3cb0045346c13e853f2ff63b
-  data.tar.gz: 279682183600050e3feac2d51d6ad1edbd5f6904
+  metadata.gz: 3fb3aa28e640ae1db6b0dad66d2b12f3b05690e3
+  data.tar.gz: 6d12eab4fe174c2c75f9f21722c742fd44d97798
 SHA512:
-  metadata.gz: e604ffac24efd5b2740e7a0bf18d26abbe208a6cb59fa4f6362bd861fafe1efa3aa4499474a016b8b68e9b6d3cec637e4c1db197d3db22ee034e09fbbbb7230f
-  data.tar.gz: 52e0d48ec3caf51f3a07380684ecd25e7373b8099df7f28325f14d389f8b17fa1c81529a177ac5a2bd240fd2059ccfd7b80e521855f08eec2ae06298637801d5
+  metadata.gz: 889c220eebfa3a1e1fd97b0ffa5fd38d925081e4ae31cdb20d9a2fac1b84508bc233dfcd7b42e5a56576c8b6a92d58f892ce98ac6fc9e478d9faefdb69439444
+  data.tar.gz: 9bfb2a47455b9d2e77741ffaa4d0288126b2bbde4521f5b1b86ef4cbbdbf215fde18c2ed036526f1b450e4c2ae2f5798907c90a21184ae750603f049fa617b00

data/.gitignore

@@ -9,3 +9,4 @@ gemfiles/*.lock
 /spec/reports/
 /tmp/
 *.gem
+.DS_Store

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in srfax.gemspec
+# Specify your gem's dependencies in srfax.gemspec.
 gemspec

data/README.md

@@ -14,7 +14,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself using: 
+Or install it yourself using:
 
     $ gem install sr_fax
 
@@ -29,13 +29,13 @@ require 'srfax'
 SrFax.setup do |config|
   config.defaults[:access_id] = '1234'
   config.defaults[:access_pwd] = 'password'
-  config.connection_defaults[:timeout] = 180
+  config.logger = Rails.logger
 end
 
 SrFax.view_inbox
 SrFax.view_outbox
-SrFax.update_fax_status(descriptor, direction) 
-SrFax.get_fax(descriptor, direction, {:sMarkasViewed => 'Y'} 
+SrFax.update_fax_status(descriptor, direction)
+SrFax.get_fax(descriptor, direction, {:sMarkasViewed => 'Y'}
 ```
 
 As an example, here is a sample queue fax call to send a fax
@@ -65,5 +65,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-Licensing: **MIT**  
+Licensing: **MIT**
 Remember: **'Great opportunities to help others seldom come, but small ones surround us daily' -- Sally Koch**

data/Rakefile

@@ -1 +1,31 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'srfax/version'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = Dir.glob("test/**/*_test.rb")
+  test.verbose = true
+end
+
+task :build do
+  system "gem build srfax.gemspec"
+end
+
+task :release => :build do
+  system "gem push srfax-#{SrFax::VERSION}.gem"
+  system "rm srfax-#{SrFax::VERSION}.gem"
+end
+
+task :default => :test

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "srfax"
+require 'bundler/setup'
+require 'srfax'
 
 # 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.
@@ -10,5 +10,5 @@ require "srfax"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/srfax.rb

@@ -1,28 +1,29 @@
 require 'restclient'
 require 'active_support'
 require 'active_support/core_ext/hash'
-require 'version'
+require 'json'
+require 'srfax/version'
 
 # This class serves as the integration component between the application and the SRFax cloud service.
-# API DOX available @ https://www.srfax.com/srf/media/SRFax-REST-API-Documentation.pdf.  
+# API DOX available @ https://www.srfax.com/srf/media/SRFax-REST-API-Documentation.pdf.
 #
 # This module currently Implements the following POST commands from the API:
-#  Get_Usage – Retrieves the account usage
+#  Get_Usage – Retrieves the account usage.
 #  Update_Viewed_Status – Mark a inbound or outbound fax as read or unread.
 #  Queue_Fax - Schedules a fax to be sent with or without cover page.
-#  Get_Fax_Inbox - Returns a list of faxes received for a specified period of time
-#  Get_Fax_Outbox - Returns a list of faxes sent for a specified period of time
-#  Retrieve_Fax – Returns a specified sent or received fax file in PDF or TIFF format
-#  Delete_Fax - Deletes specified received or sent faxes
+#  Get_Fax_Inbox - Returns a list of faxes received for a specified period of time.
+#  Get_Fax_Outbox - Returns a list of faxes sent for a specified period of time.
+#  Retrieve_Fax – Returns a specified sent or received fax file in PDF or TIFF format.
+#  Delete_Fax - Deletes specified received or sent faxes.
 #  Get_FaxStatus – Determines the status of a fax that has been scheduled for delivery.
-#  Get_MultiFaxStatus – Determines the status of a multiple faxes that hav been
+#  Get_MultiFaxStatus – Determines the status of a multiple faxes that have been
 #     scheduled for delivery.
-#  Stop_Fax - Removes a scheduled fax from the queue
+#  Stop_Fax - Removes a scheduled fax from the queue.
 # Unimplemented methods:
-#  Delete_Pending_Fax - THIS DOESN'T EXIST - but is documented to exist
+#  Delete_Pending_Fax - THIS DOESN'T EXIST - but is documented to exist.
 module SrFax
   # Base URL for accessing SRFax API
-  BASE_URL = "https://www.srfax.com/SRF_SecWebSvc.php"
+  BASE_URL = 'https://www.srfax.com/SRF_SecWebSvc.php'.freeze
 
   mattr_accessor :defaults
   # Default values hash to use with all #execute commands
@@ -34,19 +35,17 @@ module SrFax
     sResponseFormat: 'JSON' # XML or JSON
   }
 
-  mattr_accessor :connection_defaults
-  # Default values to use with the RestClient connection
-  @@connection_defaults = {
-    timeout: 180
-  }
-
   mattr_accessor :logger
-  # Logger object for use in standalone modeo or with Rails
-  @@logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
-  @@logger.level = Logger::INFO
+  # Logger object for use in standalone mode or with Rails.
+  if defined?(Rails)
+    @@logger = Rails.logger
+  else
+    @@logger = Logger.new(STDOUT)
+    @@logger.level = Logger::INFO
+  end
 
   class << self
-    # Allow configuring Srfax with a block, these will be the methods default values for passing to 
+    # Allow configuring Srfax with a block, these will be the methods default values for passing to
     # each function and will be overridden by any methods locally posted variables (ex: :action)
     #
     # @yield Accepts a block of valid configuration options to set or override default values
@@ -57,174 +56,174 @@ module SrFax
     #     config.defaults[:access_pwd] = 'password'
     #     config.defaults[:sCallerID] = '5555555555'
     #   end
-    def setup(&block)
+    def setup
       yield self
     end
-  
-    # Views the remote inbox.  By default this call does NOT update the viewed
+
+    # Views the remote inbox. By default this call does NOT update the viewed
     # or read status of the fax unless specified in options.
     #
     # @param status [String] Specify the status of the message you are listing (UNREAD, ALL, READ)
     # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
-    # @option options [String] :sPeriod Specify the period to query.  Accepts 'ALL' or 'RANGE'
-    # @option options [String] :sStatDate Used with :sPeriod and denotes the period to start at.  Format is 'YYYYMMDD'
-    # @option options [String] :sEndDate Used with :sPeriod and denotes the period to endd at.  Format is 'YYYYMMDD'
+    # @option options [String] :sPeriod Specify the period to query. Accepts 'ALL' or 'RANGE'
+    # @option options [String] :sStatDate Used with :sPeriod and denotes the period to start at. Format is 'YYYYMMDD'
+    # @option options [String] :sEndDate Used with :sPeriod and denotes the period to endd at. Format is 'YYYYMMDD'
     # @option options [String] :sIncludeSubUsers Include subuser accounts ('Y' or 'N')
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     #
-    # Example Payload for Return: 
-    #   {"Status"=>"Success", "Result"=>[{"FileName"=>"20150430124505-6104-19_1|20360095", "ReceiveStatus"=>"Ok", 
-    #   "Date"=>"Apr 30/15 02:45 PM", "EpochTime"=>1430423105, "CallerID"=>"5555555555", "RemoteID"=>"", "Pages"=>"1", 
+    # Example Payload for Return:
+    #   {"Status"=>"Success", "Result"=>[{"FileName"=>"20150430124505-6104-19_1|20360095", "ReceiveStatus"=>"Ok",
+    #   "Date"=>"Apr 30/15 02:45 PM", "EpochTime"=>1430423105, "CallerID"=>"5555555555", "RemoteID"=>"", "Pages"=>"1",
     #   "Size"=>"5000", "ViewedStatus"=>"N"} ]}
     def view_inbox(status = 'UNREAD', options = {})
-      logger.debug "Checking fax inbox from cloud service"
-      postVariables = { 
-        :action => "Get_Fax_Inbox", 
-        :sViewedStatus => status.upcase
+      logger.debug 'Checking fax inbox from cloud service'
+      postVariables = {
+        action: 'Get_Fax_Inbox',
+        sViewedStatus: status.upcase
       }.merge!(options)
       res = execute(postVariables)
-  
-      if res[:Status] != "Failure"
-        faxcount = res["Result"].count
-        faxcount > 0 ? logger.debug("Found #{faxcount} new fax(es)") : logger.debug("No faxes found matching that criteria")
+
+      if res[:Status] != 'Failure'
+        faxcount = res['Result'].length
+        faxcount > 0 ? logger.debug("Found #{faxcount} new fax(es)") : logger.debug('No faxes found matching that criteria')
       end
-  
-      return res
+
+      res
     end
-  
+
     # Uses post Get_Usage to fetch the current account usage statistics (for all associated accounts)
     #
     # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
-    # @option options [String] :sPeriod Specify the period to query.  Accepts 'ALL' or 'RANGE'
-    # @option options [String] :sStatDate Used with :sPeriod and denotes the period to start at.  Format is 'YYYYMMDD'
-    # @option options [String] :sEndDate Used with :sPeriod and denotes the period to endd at.  Format is 'YYYYMMDD'
+    # @option options [String] :sPeriod Specify the period to query. Accepts 'ALL' or 'RANGE'
+    # @option options [String] :sStatDate Used with :sPeriod and denotes the period to start at. Format is 'YYYYMMDD'
+    # @option options [String] :sEndDate Used with :sPeriod and denotes the period to endd at. Format is 'YYYYMMDD'
     # @option options [String] :sIncludeSubUsers Include subuser accounts ('Y' or 'N')
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     #
-    # Example Payload for Return: 
-    #   {"Status"=>"Success", "Result"=>[{"UserID"=>1234, "Period"=>"ALL", 
+    # Example Payload for Return:
+    #   {"Status"=>"Success", "Result"=>[{"UserID"=>1234, "Period"=>"ALL",
     #   "ClientName"=>nil, "SubUserID"=>0, "BillingNumber"=>"8888888888", "NumberOfFaxes"=>5, "NumberOfPages"=>8}]}
     def view_usage(options = {})
-      logger.debug "Viewing fax usage from cloud service"
-      postVariables = { :action => "Get_Fax_Usage" }
+      logger.debug 'Viewing fax usage from cloud service'
+      postVariables = { action: 'Get_Fax_Usage' }
       res = execute(postVariables)
-      return res
+      res
     end
-  
+
     # Uses post Get_Fax_Outbox to retrieve the usage for the account (and all subaccounts)
     #
     # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
-    # @option options [String] :sPeriod Specify the period to query.  Accepts 'ALL' or 'RANGE'
-    # @option options [String] :sStatDate Used with :sPeriod and denotes the period to start at.  Format is 'YYYYMMDD'
-    # @option options [String] :sEndDate Used with :sPeriod and denotes the period to endd at.  Format is 'YYYYMMDD'
+    # @option options [String] :sPeriod Specify the period to query. Accepts 'ALL' or 'RANGE'
+    # @option options [String] :sStatDate Used with :sPeriod and denotes the period to start at. Format is 'YYYYMMDD'
+    # @option options [String] :sEndDate Used with :sPeriod and denotes the period to endd at. Format is 'YYYYMMDD'
     # @option options [String] :sIncludeSubUsers Include subuser accounts ('Y' or 'N')
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     def view_outbox(options = {})
-      logger.debug "Viewing fax outbox from cloud service"
-      postVariables = { :action => "Get_Fax_Outbox" }
+      logger.debug 'Viewing fax outbox from cloud service'
+      postVariables = { action: 'Get_Fax_Outbox' }
       res = execute(postVariables)
-  
-      if res[:Status] != "Failure"
-        faxcount = res["Result"].count
-        faxcount > 0 ? logger.debug("Found #{faxcount} new fax(es)") : logger.debug("No faxes found matching that criteria")
+
+      if res[:Status] != 'Failure'
+        faxcount = res['Result'].length
+        faxcount > 0 ? logger.debug("Found #{faxcount} new fax(es)") : logger.debug('No faxes found matching that criteria')
       end
-  
-      return res
+
+      res
     end
-  
-    # Uses POST Retrieve_Fax to retrieve a specified fax from the server.  Returns it in the default
+
+    # Uses POST Retrieve_Fax to retrieve a specified fax from the server. Returns it in the default
     # specified format (PDF or TIFF)
-    # 
+    #
     # @param descriptor [String] Specify the status of the message you are listing (UNREAD, ALL, READ)
     # @param direction [String] Either 'IN' or 'OUT' to specify the inbox or outbox
     # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
     # @option options [String] :sMarkasViewed Update the fax status to viewed (or unviewed). Accepts 'Y' or 'N'
     # @option options [String] :sFaxFormat Update the format to retrieve the file in ('PDF' or 'TIFF')
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
-    def get_fax(descriptor, direction, options = {}) 
-      logger.debug "Retrieving fax from cloud service in the direction of '#{direction}', Descriptor:'#{descriptor}'"
-      faxname,faxid = descriptor.split('|')
-      if (faxname.nil? or faxid.nil?)
-        logger.debug "Valid descriptor not provided to get_fax function call.  Descriptor:'#{descriptor}'"
+    def get_fax(descriptor, direction, options = {})
+      logger.debug "Retrieving fax from cloud service in the direction of '#{direction}', Descriptor: '#{descriptor}'"
+      faxname, faxid = descriptor.split('|')
+      if faxname.nil? || faxid.nil?
+        logger.debug "Valid descriptor not provided to get_fax function call. Descriptor: '#{descriptor}'"
         return nil
       end
-  
-      logger.debug "Retrieving fax from cloud service"
-      postVariables = {   
-        :action => "Retrieve_Fax",
-        :sFaxFileName => descriptor,
-        :sFaxDetailsID => faxid,
-        :sDirection => direction.upcase, 
-        :sMarkasViewed => 'N'
+
+      logger.debug 'Retrieving fax from cloud service'
+      postVariables = {
+        action: 'Retrieve_Fax',
+        sFaxFileName: descriptor,
+        sFaxDetailsID: faxid,
+        sDirection: direction.upcase,
+        sMarkasViewed: 'N'
       }.merge!(options)
       res = execute(postVariables)
-      return res
+      res
     end
-    
+
     # Update the status (read/unread) for a particular fax
     #
     # @param descriptor [String] Specify the status of the message you are listing (UNREAD, ALL, READ)
     # @param direction [String] Either 'IN' or 'OUT' to specify the inbox or outbox
     # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
-    # @option options [String] :sMarkasViewed Update the fax status to viewed (or unviewed). Accepts 'Y' or 'N'.  Defaults to Y
+    # @option options [String] :sMarkasViewed Update the fax status to viewed (or unviewed). Accepts 'Y' or 'N'. Defaults to Y
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     def update_fax_status(descriptor, direction, options = {})
-      logger.debug "Updating a fax in the cloud service in the direction of '#{direction}', Descriptor:'#{descriptor}'"
-      faxname,faxid = descriptor.split('|')
-      if (faxname.nil? or faxid.nil?)
-        logger.debug "Valid descriptor not provided to get_fax function call.  Descriptor:'#{descriptor}'"
+      logger.debug "Updating a fax in the cloud service in the direction of '#{direction}', Descriptor: '#{descriptor}'"
+      faxname, faxid = descriptor.split('|')
+      if faxname.nil? || faxid.nil?
+        logger.debug "Valid descriptor not provided to get_fax function call. Descriptor: '#{descriptor}'"
         return nil
       end
 
-      postVariables = {   
-        :action => "Update_Viewed_Status",
-        :sFaxFileName => descriptor,
-        :sFaxDetailsID => faxid,
-        :sDirection => direction.upcase, 
-        :sMarkasViewed => 'Y',
+      postVariables = {
+        action: 'Update_Viewed_Status',
+        sFaxFileName: descriptor,
+        sFaxDetailsID: faxid,
+        sDirection: direction.upcase,
+        sMarkasViewed: 'Y'
       }.merge!(options)
       res = execute(postVariables)
-      return res
+      res
     end
 
     # Schedules a fax to be sent with or without cover page
     #
     # @param faxids [String, Array] Get the state of 'id' as given by the #queue_fax call
     # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
-    # @option options [String] :sResponseFormat The output response format for 
+    # @option options [String] :sResponseFormat The output response format for
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     def get_fax_status(faxids, options = {})
-      logger.debug "Gathering fax status information for id(s):'#{faxids}'"
+      logger.debug "Gathering fax status information for id(s): '#{faxids}'"
 
       if faxids.is_a? String
-        action = "Get_FaxStatus"
+        action = 'Get_FaxStatus'
       elsif faxids.is_a? Array
-        action = "Get_MultiFaxStatus"
+        action = 'Get_MultiFaxStatus'
         faxids = faxids.join('|')
       else
-        logger.warn "Error wth fax ids parameter id(s):'#{faxid}'"
-        return { :Status => "Failure" }
+        logger.warn "Error wth fax ids parameter id(s): '#{faxid}'"
+        return { Status: 'Failure' }
       end
 
-      postVariables = {   
-        :action => action,
-        :sFaxDetailsID => faxids
+      postVariables = {
+        action: action,
+        sFaxDetailsID: faxids
       }.merge!(options)
       res = execute(postVariables)
-      return res
+      res
     end
 
-    # Determines the state of a fax that has been scheduled for delivery.  Use queue fax to schedule a fax
-    # for delivery.  Note: no validation is done on the fields prior to sending.
+    # Determines the state of a fax that has been scheduled for delivery. Use queue fax to schedule a fax
+    # for delivery. Note: no validation is done on the fields prior to sending.
     #
     # @param senderEmail [String] Email address of the sender
     # @param receiverNumber [String, Array] Single 11 digit fax number or up to 50 x 11 fax numbers
     # @param faxType [String] 'SINGLE' or 'BROADCAST'
     # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
-    # @option options [String] :sResponseFormat The output response format for 
+    # @option options [String] :sResponseFormat The output response format for
     # @option options [String] :sAccountCode Internal reference number (Max of 20 Characters)
     # @option options [String] :sRetries Number of times the system is to retry a number if busy or an error is encountered – number from 0 to 6.
-    # @option options [String] :sCoverPage If you want to use one of the cover pages on file, specify the cover page you wish to use “Basic”, “Standard” , “Company” or “Personal”. If a cover page is not provided then all cover page variable will be ignored.  NOTE: If the default cover page on the account is set to “Attachments ONLY” the cover page will NOT be created irrespective of this variable.
+    # @option options [String] :sCoverPage If you want to use one of the cover pages on file, specify the cover page you wish to use “Basic”, “Standard” , “Company” or “Personal”. If a cover page is not provided then all cover page variable will be ignored. NOTE: If the default cover page on the account is set to “Attachments ONLY” the cover page will NOT be created irrespective of this variable.
     # @option options [String] :sFaxFromHeader From: On the Fax Header Line (max 30 Char)
     # @option options [String] :sCPFromName Sender’s name on the Cover Page
     # @option options [String] :sCPToName Recipient’s name on the Cover Page
@@ -234,39 +233,38 @@ module SrFax
     # @option options [String] :sFileName_x (See supported file types @  https://www.srfax.com/faqs)
     # @option options [String] :sFileContent_x Base64 encoding of file contents.
     # @option options [String] :sNotifyURL Provide an absolute URL (beginning with http:// or https://) and the SRFax system will POST back the fax status record when the fax completes. See the ‘NOTIFY URL POST’ section below for details of what is posted.
-    # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable  
+    # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     #
     # Example code (this will send a fax with 'Sample Fax' as the fileContent field):
-    #   SrFax.queue_fax "yourname@yourdomain.com", "SINGLE", "18888888888", {sFileName_1: "file1.txt", sFileContent_1: Base64.encode64("Sample Fax")}
+    #   SrFax.queue_fax "yourname@yourdomain.com", "18888888888", "SINGLE", {sFileName_1: "file1.txt", sFileContent_1: Base64.encode64("Sample Fax")}
     def queue_fax(senderEmail, receiverNumber, faxType, options = {})
-      logger.debug "Attempting to queue fax"
+      logger.debug 'Attempting to queue fax'
       receiverNumber = receiverNumber.join('|') if receiverNumber.is_a? Array
 
-      postVariables = {   
-        :action => "Queue_Fax",
-        :sSenderEmail => senderEmail,
-        :sFaxType => faxType,
-        :sToFaxNumber => receiverNumber
+      postVariables = {
+        action: 'Queue_Fax',
+        sSenderEmail: senderEmail,
+        sFaxType: faxType,
+        sToFaxNumber: receiverNumber
       }.merge!(options)
       res = execute(postVariables)
-      return res
+      res
     end
-    
-    # Attempt to stop a fax from being delivered.  See the result payload for possible condiitions in fax status
+
+    # Attempt to stop a fax from being delivered. See the result payload for possible conditions in fax status
     #
-    # @param faxid [String] Stop fax with 'id' as given by the #queue_fax call
-    # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID)
+    # @param faxid [String] Stop fax with 'id' as given by the #queue_fax call.
+    # @param options [Hash] An optional hash paramter to ovveride any default values (ie., Account ID).
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     def stop_fax(faxid, options = {})
-      action = nil 
-      logger.debug "Sending stop fax command for id:'#{faxid}'"
+      logger.debug "Sending stop fax command for id: '#{faxid}'"
 
-      postVariables = {   
-        :action => 'Stop_Fax',
-        :sFaxDetailsID => faxid
+      postVariables = {
+        action: 'Stop_Fax',
+        sFaxDetailsID: faxid
       }.merge!(options)
       res = execute(postVariables)
-      return res
+      res
     end
 
     # Delete a particular fax from the SRFax cloud service
@@ -275,75 +273,48 @@ module SrFax
     # @param direction [String] Either 'IN' or 'OUT' to specify the inbox or outbox
     # @return [Hash] A hash containing the return value (Success/Failure) and the payload where applicable
     #
-    # Example Payload for Return: 
-    #   {"Status"=>"Success", "Result"=>[{"FileName"=>"20150430124505-6104-19_1|20360095", "ReceiveStatus"=>"Ok", 
-    #   "Date"=>"Apr 30/15 02:45 PM", "EpochTime"=>1430423105, "CallerID"=>"5555555555", "RemoteID"=>"", "Pages"=>"1", 
+    # Example Payload for Return:
+    #   {"Status"=>"Success", "Result"=>[{"FileName"=>"20150430124505-6104-19_1|20360095", "ReceiveStatus"=>"Ok",
+    #   "Date"=>"Apr 30/15 02:45 PM", "EpochTime"=>1430423105, "CallerID"=>"5555555555", "RemoteID"=>"", "Pages"=>"1",
     #   "Size"=>"5000", "ViewedStatus"=>"N"} ]}
     def delete_fax(descriptor, direction)
-      logger.debug "Deleting a fax in the cloud service in the direction of '#{direction}', Descriptor:'#{descriptor}'"
-      faxname,faxid = descriptor.split('|')
-      if (faxname.nil? or faxid.nil?)
-        logger.debug "Valid descriptor not provided to get_fax function call.  Descriptor:'#{descriptor}'"
+      logger.debug "Deleting a fax in the cloud service in the direction of '#{direction}', Descriptor: '#{descriptor}'"
+      faxname, faxid = descriptor.split('|')
+      if faxname.nil? || faxid.nil?
+        logger.debug "Valid descriptor not provided to get_fax function call. Descriptor: '#{descriptor}'"
         return nil
       end
-  
-      postVariables = {   
-        :action => "Delete_Fax",
-        :sFaxFileName_x => descriptor,
-        :sFaxDetailsID_x => faxid,
-        :sDirection => direction.upcase, 
+
+      postVariables = {
+        action: 'Delete_Fax',
+        sFaxFileName_x: descriptor,
+        sFaxDetailsID_x: faxid,
+        sDirection: direction.upcase
       }
       res = execute(postVariables)
-      return res
+      res
     end
 
     private
 
     # Actually execute the RESTful post command to the #BASE_URL
     #
-    # @param postVariables [String] The list of variables to apply in the POST body when executing the request
-    # @return [Hash] The hash payload value including a proper status.  Will never return nil.
+    # @param postVariables [String] The list of variables to apply in the POST body when executing the request.
+    # @return [Hash] The hash payload value including a proper status. Will never return nil.
     def execute(postVariables)
       logger.debug postVariables.merge(defaults)
-      # redirect where necessary
-      res = RestClient::Request.execute(:method => :post, :url => BASE_URL, 
-        :payload => postVariables.merge(defaults).to_json, 
-        :timeout => connection_defaults[:timeout], :open_timeout => connection_defaults[:timeout], 
-        :headers => {:accept => :json}) { |response, request, result, &block|
-          if [301, 302, 307].include? response.code
-            response.follow_redirection(request, result, &block)
-          elsif [200].include? response.code
-            # default behaviour for OK requests
-            response.return!(request, result, &block)
-          else
-            # suppress the throw's by RestClient
-            response = Oj.dump({"Status"=>"Failure", "Result"=>"#{response}"}, mode: :compat)
-          end
-        }
-    
-#      res = RestClient.post(BASE_URL, postVariables.merge(defaults).to_json, 
-#        :content_type => :json, :accept => :json, 
-#        :timeout => connection_defaults[:timeout], :open_timeout => connection_defaults[:timeout] ){ |response, request, result, &block|
-#          if [301, 302, 307].include? response.code
-#            response.follow_redirection(request, result, &block)
-#          elsif [200].include? response.code
-#            # default behaviour
-#            response.return!(request, result, &block)
-#          else
-#            # suppress the throw's by RestClient
-#            response = {"Status"=>"Failure", "Result"=>"#{response}"}.to_json
-#          end
-#        }
-      return_data = nil
-      return_data = !res.nil? ? JSON.parse(res) : nil
-
-      if return_data.nil? || return_data.fetch("Status", "Failure") != "Success"
-        logger.debug "Execution of SR Fax command not successful" 
-        return_data = { :Status => "Failure", :Result => return_data.fetch("Result", "") } 
+      # Redirect where necessary.
+      res = RestClient.post(BASE_URL, postVariables.merge(defaults), { accept: :json })
+      unless res.code == 200
+        return { 'Status' => 'Failed', 'Result' => res.body }.with_indifferent_access
       end
 
-      return return_data.with_indifferent_access
+      return_data = JSON.parse(res.body).with_indifferent_access
+
+      if return_data['Status'] == 'Failed'
+        logger.debug 'Execution of SR Fax command not successful'
+      end
+      return_data
     end
   end
 end
-

data/lib/srfax/version.rb

@@ -0,0 +1,3 @@
+module SrFax
+  VERSION = '0.5.3'.freeze
+end

data/srfax.gemspec

@@ -1,30 +1,30 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version.rb'
+require 'srfax/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sr_fax"
+  spec.name          = 'sr_fax'
   spec.version       = SrFax::VERSION
-  spec.authors       = ["Jeff Klink", "Sean Esson"]
-  spec.email         = ["techcanuck@gmail.com"]
+  spec.authors       = ['Jeff Klink', 'Sean Esson', 'Brady Bouchard']
+  spec.email         = ['techcanuck@gmail.com']
 
-  spec.summary       = %q{SR Fax Module provides and easy way to access SR fax online services to send, receive or query faxes}
-  spec.description   = %q{This is the 'unofficial' SRFax (http://www.srfax.com) API wrapper for ruby.  The API documentation for SRFax can be found at https://www.srfax.com/srf/media/SRFax-REST-API-Documentation.pdf}
-  spec.homepage      = "https://github.com/TechCanuck/srfax"
-  spec.license       = "MIT"
+  spec.summary       = 'SR Fax Module provides and easy way to access SR fax online services to send, receive or query faxes'
+  spec.description   = "This is the 'unofficial' SRFax (http://www.srfax.com) API wrapper for ruby.  The API documentation for SRFax can be found at https://www.srfax.com/srf/media/SRFax-REST-API-Documentation.pdf"
+  spec.homepage      = 'https://github.com/TechCanuck/srfax'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry", "~> 0.8"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'pry', '~> 0.8'
+  spec.add_development_dependency 'yard', '~> 0.8'
   spec.add_dependency 'logger', '~> 1'
-  spec.add_dependency 'oj', '~> 2.11'
-  spec.add_dependency 'activesupport', '~> 4.2'
-  spec.add_dependency 'rest-client', '~> 1.7'
+  spec.add_dependency 'activesupport', ['>= 4.2', '< 6']
+  spec.add_dependency 'rest-client', '~> 2.0'
 end

metadata

@@ -1,16 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: sr_fax
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Jeff Klink
 - Sean Esson
+- Brady Bouchard
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2016-08-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -31,14 +46,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -81,48 +96,40 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-- !ruby/object:Gem::Dependency
-  name: oj
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
 description: This is the 'unofficial' SRFax (http://www.srfax.com) API wrapper for
   ruby.  The API documentation for SRFax can be found at https://www.srfax.com/srf/media/SRFax-REST-API-Documentation.pdf
 email:
@@ -139,7 +146,7 @@ files:
 - bin/console
 - bin/setup
 - lib/srfax.rb
-- lib/version.rb
+- lib/srfax/version.rb
 - srfax.gemspec
 homepage: https://github.com/TechCanuck/srfax
 licenses:

data/lib/version.rb

@@ -1,4 +0,0 @@
-module SrFax
-  # Version # for SrFax
-  VERSION = '0.4.1'
-end