efax 1.3.3 → 1.4.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7 # (current default)
+  - ree
+  - 1.9.2

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "test-unit", "~> 2.3.2", :require => false
+gem "mocha", "~> 0.9.12", :require => false
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    efax (1.3.3)
+      builder (~> 3.0.0)
+      hpricot (~> 0.8.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    hpricot (0.8.4)
+    mocha (0.9.12)
+    rake (0.9.2)
+    test-unit (2.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  efax!
+  mocha (~> 0.9.12)
+  rake
+  test-unit (~> 2.3.2)

data/README.md

@@ -0,0 +1,76 @@
+# efax [![Build Status](https://secure.travis-ci.org/szimek/efax.png)](http://travis-ci.org/szimek/efax)
+
+Ruby library for accessing [eFax Developer service](http://www.efaxdeveloper.com).
+
+You can find eFax Developer API guides at [efaxdeveloper.com](https://secure.efaxdeveloper.com/techDocs/eFaxDeveloper_Universal_Implementation_Kit_v1.0.zip) or on [Scribd](www.scribd.com/doc/5382394/eFax-Developer-Universal-User-Guide-Outbound).
+
+## Usage
+
+### Outbound Faxes
+
+First you need to provide your account id and credentials:
+
+```ruby
+EFax::Request.account_id = <your account id>
+EFax::Request.user       = <your login>
+EFax::Request.password   = <your password>
+```
+Sending an HTML page using eFax service is pretty simple:
+
+```ruby
+response = EFax::OutboundRequest.post(recipient_name, company_name, fax_number, subject, content)
+```
+
+See `EFax::RequestStatus` class for details on status codes.
+
+
+Having ID of your request, you can get its current status:
+
+```ruby
+response = OutboundRequestStatus.post(doc_id)
+```
+
+The status response has the following attributes:
+
+```ruby
+response.status_code
+response.message          # "user friendly" status message
+```
+
+See `EFax::QueryStatus` class for details on status codes.
+
+### Inbound Faxes
+
+Inbound faxes work by exposing a URL that EFax can post to when it receives a fax on your account. An example end-point in rails might look like this:
+
+```ruby
+class InboundFaxesController < AdminController
+  def create
+    efax = EFax::InboundPostRequest.receive_by_params(params)
+    Fax.create(:file => efax.file, :name => efax.name) # etc
+    render :text => efax.post_successful_message # This is important to let EFax know you successfully processed the incoming request.
+  end
+end
+```
+
+## Test helpers
+
+You can generate a `EFax::InboundPostRequest` based on optional explicit fields by using a helper method `efax_inbound_post`:
+
+In your tests:
+
+```ruby
+require "efax/helpers/inbound_helpers"
+
+describe InboundFax do
+  include EFax::Helpers::InboundHelpers
+
+  it "should create a fax from efax data" do
+    person = Person.make
+    person.save
+    efax = efax_inbound_post(:barcode => person.barcode_number)
+    fax = InboundFax.create_from_efax!(efax)
+    fax.person.should == person
+  end
+end
+```

data/Rakefile

@@ -1,43 +1,10 @@
 require 'rubygems'
-require 'rake'
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'bundler/setup'
 require 'rake/testtask'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "efax"
-    gem.summary = 'Ruby library for accessing the eFax Developer service'
-    gem.authors = ["Szymon Nowak", "Pawel Kozlowski", "Dr Nic Williams"]
-    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
-
-Rake::RDocTask.new do |rdoc|
-  files =['README.rdoc', 'lib/**/*.rb']
-  rdoc.rdoc_files.add(files)
-  rdoc.main = "README.rdoc" # page to start on
-  rdoc.title = 'eFax: Ruby library for accessing the eFax Developer service'
-  rdoc.rdoc_dir = 'rdoc' # rdoc output folder
-  rdoc.options << '--line-numbers'
-end
-
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/**/*.rb']
 end
+
+desc "Default: run all tests"
+task :default => [:test]

data/efax.gemspec

@@ -1,62 +1,14 @@
-# Generated by jeweler
-# 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.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.name = "efax"
+  s.version = "1.4.0"
   s.authors = ["Szymon Nowak", "Pawel Kozlowski", "Dr Nic Williams"]
-  s.date = %q{2010-03-17}
-  s.email = %q{szimek@gmail.com}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "efax.gemspec",
-     "lib/efax.rb",
-     "lib/efax/helpers/inbound_helpers.rb",
-     "lib/efax/inbound.rb",
-     "lib/efax/outbound.rb",
-     "test/efax_inbound_test.rb",
-     "test/efax_outbound_test.rb",
-     "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/szimek/efax}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{efax}
-  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",
-     "test/efax_outbound_test.rb",
-     "test/test_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    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
+  s.email = "szimek@gmail.com"
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.homepage = "http://github.com/szimek/efax"
+  s.require_path = "lib"
+  s.rubygems_version = "1.3.6"
+  s.summary = "Ruby library for accessing the eFax Developer service"
+  s.add_runtime_dependency "builder", "~> 3.0.0"
+  s.add_runtime_dependency "hpricot", "~> 0.8.1"
 end
-

data/lib/efax/inbound.rb

@@ -1,13 +1,13 @@
 require 'hpricot'
 require 'base64'
 require 'tempfile'
-require 'time'
+require 'date'
 
 module EFax
   class InboundPostStatus
     SUCCESS = 1
   end
-  
+
   class InboundPostRequest
     attr_reader :encoded_file_contents,
                 :file_type,
@@ -22,9 +22,9 @@ module EFax
                 :date_received,
                 :request_date,
                 :barcodes
-    
+
     alias_method :sender_fax_number, :ani
-    
+
     def initialize(xml)
       doc            = Hpricot(xml)
       @encoded_file_contents = doc.at(:filecontents).inner_text
@@ -37,34 +37,52 @@ module EFax
       @mcfid         = doc.at(:mcfid).inner_text.to_i
       @page_count    = doc.at(:pagecount).inner_text.to_i
       @request_type  = doc.at(:requesttype).inner_text
-      @date_received = Time.parse("#{doc.at(:datereceived).inner_text} -08:00")
-      @request_date  = Time.parse("#{doc.at(:requestdate).inner_text} -08:00")
+      @date_received = datetime_to_time(DateTime.strptime("#{doc.at(:datereceived).inner_text} -08:00", "%m/%d/%Y %H:%M:%S %z"))
+      @request_date  = datetime_to_time(DateTime.strptime("#{doc.at(:requestdate).inner_text} -08:00", "%m/%d/%Y %H:%M:%S %z"))
       @barcodes      = doc.search("//barcode/key").map { |key| key.inner_html }
     end
-    
+
     def file_contents
       @file_contents ||= Base64.decode64(encoded_file_contents)
     end
-    
+
     def file
       @file ||= begin
-        file = Tempfile.new(fax_name)
+        if defined?(Encoding)
+          file = Tempfile.new(fax_name, {:encoding => 'ascii-8bit'})
+        else
+          file = Tempfile.new(fax_name)
+        end
         file << file_contents
         file.rewind
         file
       end
     end
+
     def post_successful_message
       "Post Successful"
     end
-    
+
     def self.receive_by_params(params)
       receive_by_xml(params[:xml] || params["xml"])
     end
-  
+
     def self.receive_by_xml(xml)
       new(xml)
     end
+
+
+    private
+
+    def datetime_to_time(datetime)
+      if datetime.respond_to?(:to_time)
+        datetime.to_time
+      else
+        d = datetime.new_offset(0)
+        d.instance_eval do
+          Time.utc(year, mon, mday, hour, min, sec + sec_fraction)
+        end.getlocal
+      end
+    end
   end
 end
-

data/test/efax_inbound_test.rb

@@ -30,6 +30,7 @@ module EFaxInboundTest
       assert_not_nil response.file_contents
       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)
@@ -39,4 +40,3 @@ module EFaxInboundTest
 
   end
 end
-

metadata

@@ -1,76 +1,52 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: efax
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 3
-  - 3
-  version: 1.3.3
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Szymon Nowak
 - Pawel Kozlowski
 - Dr Nic Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-03-17 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hpricot
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 8
-        - 1
-        version: 0.8.1
+date: 2011-08-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: &2153358560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: test-unit
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: *2153358560
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: &2153357980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        version: "2"
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mocha
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 9
-        version: "0.9"
-  type: :development
-  version_requirements: *id003
+  version_requirements: *2153357980
 description: 
 email: szimek@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .gitignore
-- README.rdoc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
 - Rakefile
-- VERSION
 - efax.gemspec
 - lib/efax.rb
 - lib/efax/helpers/inbound_helpers.rb
@@ -79,37 +55,31 @@ files:
 - test/efax_inbound_test.rb
 - test/efax_outbound_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/szimek/efax
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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: efax
-rubygems_version: 1.3.6
+rubyforge_project: 
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Ruby library for accessing the eFax Developer service
-test_files: 
+test_files:
 - test/efax_inbound_test.rb
 - test/efax_outbound_test.rb
 - test/test_helper.rb

data/README.rdoc

@@ -1,70 +0,0 @@
-= efax
-
-Ruby library for accessing the eFax Developer service (http://www.efaxdeveloper.com).
-
-Strange class names and their attribute names come from "eFax Developer Universal User Guide for Outbound Processing" document.
-You can get it on eFax Developer pages or on Scribd (http://www.scribd.com/doc/5382394/eFax-Developer-Universal-User-Guide-Outbound).
-
-== Usage
-
-=== Outbound Faxes
-
-First you need to provide your account id and credentials:
-  EFax::Request.account_id = <your account id>
-  EFax::Request.user       = <your login>
-  EFax::Request.password   = <your password>
-
-
-Sending an HTML page using eFax service is pretty simple:
-  response = EFax::OutboundRequest.post(recipient_name, company_name, fax_number, subject, content)
-
-The response object has the following attributes:
-  response.status_code
-  response.doc_id           # unique identifier of your request
-  response.error_level
-  response.error_message
-
-See EFax::RequestStatus class for details on status codes.
-
-
-Having ID of your request, you can get its current status:
-  response = OutboundRequestStatus.post(doc_id)
-
-The status response has the following attributes:
-  response.status_code
-  response.message          # "user friendly" status message
-
-See EFax::QueryStatus class for details on status codes.
-
-=== Inbound Faxes
-
-Inbound faxes work by exposing a URL that EFax can post to when it receives a fax on your account. An example end-point in rails might look like this:
-
-  class InboundFaxesController < AdminController
-    def create
-      efax = EFax::InboundPostRequest.receive_by_params(params)
-      Fax.create(:file => efax.file, :name => efax.name) # etc
-      render :text => efax.post_successful_message # This is important to let EFax know you successfully processed the incoming request.
-    end
-  end
-
-== Test Helpers
-
-You can generate a EFax::InboundPostRequest based on optional explicit fields by using a helper method +efax_inbound_post+:
-
-In your tests:
-
-    require "efax/helpers/inbound_helpers"
-
-    describe InboundFax do
-      include EFax::Helpers::InboundHelpers
-
-      it "should create a fax from efax data" do
-        person = Person.make
-        person.save
-        efax = efax_inbound_post(:barcode => person.barcode_number)
-        fax = InboundFax.create_from_efax!(efax) 
-        fax.person.should == person
-      end
-    end
-    

data/VERSION

@@ -1 +0,0 @@
-1.3.3