efax 1.3.2 → 1.3.3

data/Rakefile

@@ -4,7 +4,6 @@ require 'rake/clean'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'rake/testtask'
-require 'spec/rake/spectask'
 
 begin
   require 'jeweler'
@@ -15,14 +14,17 @@ begin
     gem.email = "szimek@gmail.com"
     gem.homepage = "http://github.com/szimek/efax"
     gem.rubyforge_project = "efax"
-    
+
     gem.add_dependency('hpricot', '>= 0.8.1')
+    gem.add_development_dependency('test-unit', '~> 2')
     gem.add_development_dependency('mocha', '>= 0.9')
   end
-  
+
   Jeweler::RubyforgeTasks.new do |rubyforge|
     rubyforge.doc_task = "rdoc"
   end
+
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
@@ -39,7 +41,3 @@ end
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*.rb']
 end
-
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = FileList['spec/**/*.rb']
-end

data/VERSION

@@ -1 +1 @@
-1.3.2
+1.3.3

data/efax.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{efax}
-  s.version = "1.3.2"
+  s.version = "1.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Szymon Nowak", "Pawel Kozlowski", "Dr Nic Williams"]
-  s.date = %q{2009-10-09}
+  s.date = %q{2010-03-17}
   s.email = %q{szimek@gmail.com}
   s.extra_rdoc_files = [
     "README.rdoc"
@@ -18,7 +18,6 @@ Gem::Specification.new do |s|
     ".gitignore",
      "README.rdoc",
      "Rakefile",
-     "TODO",
      "VERSION",
      "efax.gemspec",
      "lib/efax.rb",
@@ -33,7 +32,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{efax}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Ruby library for accessing the eFax Developer service}
   s.test_files = [
     "test/efax_inbound_test.rb",
@@ -47,13 +46,17 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<hpricot>, [">= 0.8.1"])
+      s.add_development_dependency(%q<test-unit>, ["~> 2"])
       s.add_development_dependency(%q<mocha>, [">= 0.9"])
     else
       s.add_dependency(%q<hpricot>, [">= 0.8.1"])
+      s.add_dependency(%q<test-unit>, ["~> 2"])
       s.add_dependency(%q<mocha>, [">= 0.9"])
     end
   else
     s.add_dependency(%q<hpricot>, [">= 0.8.1"])
+    s.add_dependency(%q<test-unit>, ["~> 2"])
     s.add_dependency(%q<mocha>, [">= 0.9"])
   end
 end
+

data/lib/efax/outbound.rb

@@ -17,7 +17,7 @@ end
 
 module EFax
   # URL of eFax web service
-  Url      = "https://secure.efaxdeveloper.com/EFax_WebFax.serv"  
+  Url      = "https://secure.efaxdeveloper.com/EFax_WebFax.serv"
   # URI of eFax web service
   Uri      = URI.parse(Url)
   # Prefered content type
@@ -45,7 +45,7 @@ module EFax
     def self.account_id=(id)
       @@account_id = id
     end
-    
+
     def self.params(content)
       escaped_xml = ::URI.escape(content, Regexp.new("[^#{::URI::PATTERN::UNRESERVED}]"))
       "id=#{account_id}&xml=#{escaped_xml}&respond=XML"
@@ -53,7 +53,7 @@ module EFax
 
     private_class_method :params
   end
-  
+
   class OutboundRequest < Request
     def self.post(name, company, fax_number, subject, content, content_type = :html)
       xml_request = xml(name, company, fax_number, subject, content, content_type)
@@ -62,7 +62,7 @@ module EFax
       end
       OutboundResponse.new(response)
     end
-    
+
     def self.xml(name, company, fax_number, subject, content, content_type = :html)
       xml_request = ""
       xml = Builder::XmlMarkup.new(:target => xml_request, :indent => 2 )
@@ -141,7 +141,7 @@ module EFax
       end
       OutboundStatusResponse.new(response)
     end
-    
+
     def self.xml(doc_id)
       xml_request = ""
       xml = Builder::XmlMarkup.new(:target => xml_request, :indent => 2 )
@@ -182,7 +182,7 @@ module EFax
         @message = doc.at(:message).innerText
         @classification = doc.at(:classification).innerText.delete('"')
         @outcome = doc.at(:outcome).innerText.delete('"')
-        if @classification.empty? && @outcome.empty?
+        if !sent_yet?(classification, outcome) || busy_signal?(classification)
           @status_code = QueryStatus::PENDING
         elsif @classification == "Success" && @outcome == "Success"
           @status_code = QueryStatus::SENT
@@ -194,5 +194,14 @@ module EFax
         @message = "HTTP request failed (#{response.code})"
       end
     end
+
+    def busy_signal?(classification)
+      classification == "Busy"
+    end
+
+    def sent_yet?(classification, outcome)
+      !classification.empty? || !outcome.empty?
+    end
+
   end
-end
+end

data/test/efax_inbound_test.rb

@@ -10,10 +10,10 @@ module EFaxInboundTest
       EFax::InboundPostRequest.expects(:receive_by_xml).with(efax_inbound_post_xml).returns(response = mock)
       assert_equal(EFax::InboundPostRequest.receive_by_params({:xml => efax_inbound_post_xml}), response)
     end
-    
+
     def test_receive_by_xml
       response = efax_inbound_post(:barcodes => %w[EFAXTEST1A EFAXTEST2A EFAXTEST3A EFAXTEST4A EFAXTEST5A])
-      
+
       assert_equal efax_inbound_post_file_contents, response.encoded_file_contents
       assert_equal :pdf,          response.file_type
       assert_equal '8587123600',  response.sender_fax_number
@@ -31,7 +31,7 @@ module EFaxInboundTest
       assert_not_nil response.file
       assert_respond_to response.file, :read
       assert_equal response.file_contents, response.file.read
-      
+
       # According to docs these will always be "Pacific Time Zone" (sometimes -8, sometimes -7 -- using -8)
       assert_equal Time.utc(2005,8,18,20,2,13), response.date_received
       assert_equal Time.utc(2005,8,18,20,2,25), response.request_date

data/test/efax_outbound_test.rb

@@ -60,7 +60,7 @@ module EFaxOutboundTest
       XML
       http_response = mock()
       http_response.expects(:is_a?).with(Net::HTTPOK).returns(true)
-      http_response.expects(:body).returns(xml)      
+      http_response.expects(:body).returns(xml)
       response = EFax::OutboundResponse.new(http_response)
       assert_equal EFax::RequestStatus::FAILURE, response.status_code
       assert_nil response.doc_id
@@ -88,7 +88,7 @@ module EFaxOutboundTest
       XML
       http_response = mock()
       http_response.expects(:is_a?).with(Net::HTTPOK).returns(true)
-      http_response.expects(:body).returns(xml)      
+      http_response.expects(:body).returns(xml)
       response = EFax::OutboundResponse.new(http_response)
       assert_equal EFax::RequestStatus::FAILURE, response.status_code
       assert_nil response.doc_id
@@ -151,7 +151,7 @@ module EFaxOutboundTest
       XML
       http_response = mock()
       http_response.expects(:is_a?).with(Net::HTTPOK).returns(true)
-      http_response.expects(:body).returns(xml)      
+      http_response.expects(:body).returns(xml)
       response = EFax::OutboundStatusResponse.new(http_response)
       assert_equal "Your transmission has completed.", response.message
       assert_equal "Success", response.outcome
@@ -159,6 +159,58 @@ module EFaxOutboundTest
       assert_equal EFax::QueryStatus::SENT, response.status_code
     end
 
+        def test_busy_response
+      xml = <<-XML
+        <?xml version="1.0"?>
+        <OutboundStatusResponse>
+          <Transmission>
+            <TransmissionControl>
+              <TransmissionID></TransmissionID>
+            </TransmissionControl>
+            <Recipients>
+              <Recipient>
+                <DOCID>12345678</DOCID>
+                <Name>Mike Rotch</Name>
+                <Company>Moe's</Company>
+                <Fax>12345678901</Fax>
+                <Status>
+                  <Message>Your transmission is waiting to be sent.</Message>
+                  <Classification>Busy</Classification>
+                  <Outcome>Normal busy: remote end busy (off hook)</Outcome>
+                </Status>
+                <LastAttempt>
+                  <LastDate></LastDate>
+                  <LastTime></LastTime>
+                </LastAttempt>
+                <NextAttempt>
+                  <NextDate></NextDate>
+                  <NextTime></NextTime>
+                </NextAttempt>
+                <Pages>
+                  <Scheduled>1</Scheduled>
+                  <Sent>1</Sent>
+                </Pages>
+                <BaudRate>14400</BaudRate>
+                <Duration>0.4</Duration>
+                <Retries>1</Retries>
+                <RemoteCSID>"-"</RemoteCSID>
+              </Recipient>
+            </Recipients>
+          </Transmission>
+        </OutboundStatusResponse>
+      XML
+
+      http_response = mock()
+      http_response.expects(:is_a?).with(Net::HTTPOK).returns(true)
+      http_response.expects(:body).returns(xml)
+      response = EFax::OutboundStatusResponse.new(http_response)
+
+      assert_equal "Normal busy: remote end busy (off hook)", response.outcome
+      assert_equal "Busy", response.classification
+      assert_equal "Your transmission is waiting to be sent.", response.message
+      assert_equal EFax::QueryStatus::PENDING, response.status_code
+    end
+
     def test_pending_response
       xml = <<-XML
         <?xml version="1.0"?>
@@ -202,9 +254,9 @@ module EFaxOutboundTest
 
       http_response = mock()
       http_response.expects(:is_a?).with(Net::HTTPOK).returns(true)
-      http_response.expects(:body).returns(xml)      
+      http_response.expects(:body).returns(xml)
       response = EFax::OutboundStatusResponse.new(http_response)
-      
+
       assert_equal "", response.outcome
       assert_equal "", response.classification
       assert_equal EFax::QueryStatus::PENDING, response.status_code
@@ -253,9 +305,9 @@ module EFaxOutboundTest
 
       http_response = mock()
       http_response.expects(:is_a?).with(Net::HTTPOK).returns(true)
-      http_response.expects(:body).returns(xml)      
+      http_response.expects(:body).returns(xml)
       response = EFax::OutboundStatusResponse.new(http_response)
-      
+
       assert_equal "Your fax caused the world to end", response.message
       assert_equal "End of days", response.outcome
       assert_equal "Apocalyptic failure", response.classification
@@ -329,30 +381,4 @@ module EFaxOutboundTest
       end
     end
   end
-
-  class OutboundStatusTest < Test::Unit::TestCase
-    def test_generate_xml
-      expected_xml = <<-XML
-        <?xml version="1.0" encoding="UTF-8"?>
-        <OutboundStatus>
-          <AccessControl>
-            <UserName>Mike Rotch</UserName>
-            <Password>moes</Password>
-          </AccessControl>
-          <Transmission>
-            <TransmissionControl>
-              <DOCID>123456</DOCID>
-            </TransmissionControl>
-          </Transmission>
-        </OutboundStatus>
-      XML
-
-      EFax::Request.user = "Mike Rotch"
-      EFax::Request.password = "moes"
-      EFax::OutboundStatus.publicize_class_methods do
-        assert_equal expected_xml.delete(" "), EFax::OutboundStatus.xml("123456").delete(" ")
-      end
-    end
-  end
-
 end

data/test/test_helper.rb

@@ -1,5 +1,6 @@
-require 'test/unit'
 require 'rubygems'
+gem 'test-unit', '~> 2'
+require 'test/unit'
 require 'mocha'
 
 class Class
@@ -16,4 +17,4 @@ class Class
     yield
     self.class_eval { private_class_method(*saved_private_class_methods) }
   end
-end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: efax
 version: !ruby/object:Gem::Version 
-  version: 1.3.2
+  prerelease: false
+  segments: 
+  - 1
+  - 3
+  - 3
+  version: 1.3.3
 platform: ruby
 authors: 
 - Szymon Nowak
@@ -11,29 +16,48 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-09 00:00:00 +10:00
+date: 2010-03-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hpricot
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 1
         version: 0.8.1
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: mocha
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
         version: "0.9"
-    version: 
+  type: :development
+  version_requirements: *id003
 description: 
 email: szimek@gmail.com
 executables: []
@@ -46,7 +70,6 @@ files:
 - .gitignore
 - README.rdoc
 - Rakefile
-- TODO
 - VERSION
 - efax.gemspec
 - lib/efax.rb
@@ -69,18 +92,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: efax
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ruby library for accessing the eFax Developer service

data/TODO

@@ -1,2 +0,0 @@
-- provide simpler interface like EFax#send_request and EFax#query_status
-- raise exception if account info or credentials are not set