fax_finder 0.1.0 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/fax_finder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fax_finder}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Erich L. Timkar"]
-  s.date = %q{2011-05-02}
+  s.date = %q{2011-05-10}
   s.email = %q{erich@hordesoftware.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -29,9 +29,11 @@ Gem::Specification.new do |s|
     "lib/fax_finder/request.rb",
     "lib/fax_finder/response.rb",
     "lib/fax_finder/send.rb",
+    "pkg/fax_finder-0.1.0.gem",
     "test/fixtures/send_request_external.xml",
     "test/fixtures/send_request_inline.xml",
     "test/fixtures/send_response_success.xml",
+    "test/fixtures/test.pdf",
     "test/query_test.rb",
     "test/request_test.rb",
     "test/response_test.rb",

data/lib/fax_finder/request.rb

@@ -22,6 +22,7 @@ module FaxFinder
 
     def post
       response_body=nil
+
       begin
         Net::HTTP.start(Request.host, Request.port) { |http|  
           http.use_ssl=Request.ssl

data/lib/fax_finder/send.rb

@@ -4,13 +4,13 @@ require 'builder'
 module FaxFinder
   module SendClassMethods
 
-    def post(recipient_fax, external_url, options={})
+    def post(recipient_fax, options={})
       super(){
-        construct_http_request(recipient_fax, external_url, options)
+        construct_http_request(recipient_fax, options)
       }
     end
 
-    def construct_xml(recipient_fax, external_url, options={})
+    def construct_xml(recipient_fax, options={})
       xml = ""
       builder = Builder::XmlMarkup.new(:target => xml, :indent => 2 )      
       builder.instruct!(:xml, :version=>'1.0', :encoding=>'UTF-8')
@@ -19,10 +19,24 @@ module FaxFinder
       time=time.utc if time && !time.utc?
       formatted_time=time ? time.strftime(Request::TIME_FORMAT) : nil
       
+      external_url=options[:external_url]
+      if external_url.nil? && _content=options[:content]
+        if _content.is_a?(String)
+          content=_content
+        else
+          _content.rewind
+          _content.binmode
+          attachment_name = options[:attachment_name] || File.basename(_content.path)
+          content=Base64.encode64(_content.read).gsub(/\n/, '')
+        end
+      else
+        content=nil
+      end
+      
       builder.schedule_fax {
         builder.cover_page do
-          # builder.subject(options[:subject])
-          # builder.comment(options[:comment])
+          builder.subject(options[:subject])
+          builder.comment(options[:comment])
           builder.enabled('false')
         end
 
@@ -40,18 +54,28 @@ module FaxFinder
           builder.name(options[:sender_name])
         end
 
-        builder.attachment do
-          builder.location('external')
-          builder.url(external_url)
+       builder.attachment do
+          if external_url
+            builder.location('external')
+            builder.url(external_url)
+          elsif content
+            builder.content(content)
+            builder.name(options[:filename])
+            builder.attachment_name(attachment_name)
+            builder.content_transfer_encoding('base64')
+            builder.location('inline')
+            builder.name(attachment_name)
+            builder.content_type(options[:content_type])
+          end
         end
         builder.schedule_all_at(formatted_fax_finder_time(options[:schedule_all_at]))
       }
       xml
     end
     
-    def construct_http_request(recipient_fax, external_url, options={})
+    def construct_http_request(recipient_fax, options={})
       request = Net::HTTP::Post.new(Request::BASE_PATH)
-      request.body=construct_xml(recipient_fax, external_url, options)
+      request.body=construct_xml(recipient_fax, options)
       request
     end
 

data/lib/fax_finder.rb

@@ -1,7 +1,7 @@
 #--
 # (The MIT License)
 #
-# Copyright (c) 2008 Szymon Nowak & Pawel Kozlowski (U2I)
+# Copyright (c) 2011 Horde Software, LLC (U2I)
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to
@@ -25,7 +25,6 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 require 'net/http'
 require 'net/https'
-
 require 'fax_finder/response.rb'
 require 'fax_finder/request.rb'
 require 'fax_finder/send.rb'

data/test/send_test.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/test_helper'
-
+require "base64"
 module FaxFinder
   OPTIONS={:subject=>'Something',
     :comment=>'Comment',
@@ -23,17 +23,17 @@ module FaxFinder
     end
     
     def test_posts_returns_response
-      assert_instance_of(FaxFinder::Response, Send.post(nil, nil))
+      assert_instance_of(FaxFinder::Response, Send.post(nil))
     end
   end
 
   class SendConstructXMLTest<Test::Unit::TestCase
     def setup
-      @doc=Nokogiri::XML(Send.construct_xml('1234567890', 'https://localhost/something', OPTIONS))
+      @doc=Nokogiri::XML(Send.construct_xml('1234567890', OPTIONS.merge(:external_url=>'https://localhost/something')))
     end
     
     def test_returns_string_and_doesnt_blow_up
-      assert_nothing_thrown { assert_instance_of(String, Send.construct_xml(nil, nil)) }
+      assert_nothing_thrown { assert_instance_of(String, Send.construct_xml(nil)) }
     end
 
     def test_includes_subject
@@ -89,16 +89,78 @@ module FaxFinder
     end
 
     def test_converts_to_utc
-      @doc=Nokogiri::XML(Send.construct_xml('1234567890', 'https://localhost/something', OPTIONS.merge(:schedule_all_at=>Time.now)))
+      @doc=Nokogiri::XML(Send.construct_xml('1234567890', OPTIONS.merge(:schedule_all_at=>Time.now, :external_url=>'https://localhost/something')))
       assert_equal(Time.now.utc.strftime(Request::TIME_FORMAT), @doc.xpath('//schedule_fax/schedule_all_at').text)
     end
 
   end
   
+  class SendConstructXMLTestEmbedDocument<Test::Unit::TestCase
+    def setup
+      @file=File.open(File.join('test', 'fixtures', 'test.pdf'))
+      @options=OPTIONS.merge(
+        :content=>@file,
+        :content_type=>'application/pdf'
+      )
+      @doc=Nokogiri::XML(Send.construct_xml('1234567890', @options))
+    end
+    
+    def test_encodes_files
+      @file.rewind
+      @file.binmode
+      encoded=Base64.encode64(@file.read).gsub(/\n/, '')
+      assert_equal(encoded, @doc.xpath('//schedule_fax/attachment/content').text)
+    end
+    
+    def test_should_call_rewind_on_the_file
+      @file.rewind
+      @file.binmode
+      encoded=Base64.encode64(@file.read).gsub(/\n/, '')
+      @doc=Nokogiri::XML(Send.construct_xml('1234567890', @options.merge(:content=>@file)))
+      assert_equal(encoded, @doc.xpath('//schedule_fax/attachment/content').text)
+    end
+  
+    def test_including_an_external_url_will_override_embedded_document
+      @doc=Nokogiri::XML(Send.construct_xml('1234567890', @options.merge(:external_url=>'https://localhost/something')))
+      assert_empty(@doc.xpath('//schedule_fax/attachment/content'))
+    end
+
+    def test_supports_passing_in_a_base64_string_directly
+      @file.rewind
+      @file.binmode
+      encoded=Base64.encode64(@file.read).gsub(/\n/, '')
+      
+      @doc=Nokogiri::XML(Send.construct_xml('1234567890', @options.merge(:content=>encoded)))
+      assert_equal(encoded, @doc.xpath('//schedule_fax/attachment/content').text)
+    end
+    
+    def test_sets_the_content_type
+      assert_equal('application/pdf', @doc.xpath('//schedule_fax/attachment/content_type').text)      
+    end
+    
+    def test_sets_location_as_inline
+      assert_equal('inline', @doc.xpath('//schedule_fax/attachment/location').text)      
+    end
+    
+    def test_sets_the_filename_from_the_file_path
+      assert_equal(File.basename(@file.path), @doc.xpath('//schedule_fax/attachment/name').text)
+    end
+
+    def test_sets_the_content_transfer_encoding
+      assert_equal('base64', @doc.xpath('//schedule_fax/attachment/content_transfer_encoding').text)
+    end
+    
+    def test_supports_overrding_filename
+      @doc=Nokogiri::XML(Send.construct_xml('1234567890', @options.merge(:attachment_name=>'attachment.name')))
+      assert_equal('attachment.name', @doc.xpath('//schedule_fax/attachment/name').text)
+    end
+    
+  end
+  
   class SendConstructHttpRequestTest<Test::Unit::TestCase
     def setup
       Request.configure('example.com', 'user', 'password')
-      @http_request=Send.construct_http_request('1234567890', 'https://localhost/something', OPTIONS)
+      @http_request=Send.construct_http_request('1234567890', OPTIONS.merge(:external_url=>'https://localhost/something'))
     end
 
     def test_returns_a_post
@@ -106,7 +168,7 @@ module FaxFinder
     end
     
     def test_sets_body
-      assert_equal(Send.construct_xml('1234567890', 'https://localhost/something', OPTIONS), @http_request.body)
+      assert_equal(Send.construct_xml('1234567890', OPTIONS.merge(:external_url=>'https://localhost/something')), @http_request.body)
     end
     
     def test_sets_path

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fax_finder
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Erich L. Timkar
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-02 00:00:00 Z
+date: 2011-05-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -101,9 +101,11 @@ files:
 - lib/fax_finder/request.rb
 - lib/fax_finder/response.rb
 - lib/fax_finder/send.rb
+- pkg/fax_finder-0.1.0.gem
 - test/fixtures/send_request_external.xml
 - test/fixtures/send_request_inline.xml
 - test/fixtures/send_response_success.xml
+- test/fixtures/test.pdf
 - test/query_test.rb
 - test/request_test.rb
 - test/response_test.rb