interfax-ruby 0.1.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@interfax-ruby --create

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "savon", "0.9.9"
+
+group :development do
+  gem 'ruby-debug19', '0.11.6'
+  gem "rspec", "2.8.0"
+  gem "rdoc", "3.12"
+  gem "bundler", "1.0.22"
+  gem "jeweler", "1.8.3"
+  gem "simplecov", "0.5.3", :require => false
+  gem "fakeweb", "1.3.0"
+  gem "vcr", "1.11.3"
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
+    archive-tar-minitar (0.5.2)
+    builder (3.0.0)
+    columnize (0.3.6)
+    diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    git (1.2.5)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    httpi (0.9.5)
+      rack
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    nori (1.1.0)
+    rack (1.4.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    savon (0.9.9)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.1)
+      wasabi (~> 2.1)
+    simplecov (0.5.3)
+      multi_json (~> 1.0.3)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    vcr (1.11.3)
+    wasabi (2.1.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 1.0.22)
+  fakeweb (= 1.3.0)
+  jeweler (= 1.8.3)
+  rdoc (= 3.12)
+  rspec (= 2.8.0)
+  ruby-debug19 (= 0.11.6)
+  savon (= 0.9.9)
+  simplecov (= 0.5.3)
+  vcr (= 1.11.3)

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2013 Rafael Lima
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# Ruby Gem for Interfax SOAP API
+
+This is a ruby wrapper to send fax using [Interfax](http://www.interfax.net/)
+
+API Reference: [Outbound Fax SOAP API](http://www.interfax.net/en/dev/webservice/reference)
+
+## Install
+
+    gem install interfax-ruby
+
+### Usage
+
+```ruby
+require 'interfax'
+
+interfax = Interfax.new(username: 'myuser', password: 'mypassword')
+source_path = "/tmp/myfile.pdf"
+if interfax.upload_file_chunk(source_path)
+  result = interfax.sendfax_ex_2(
+    fax_numbers: '+55-21-99999999',
+    postpone: '2000-01-01T10:00:00.000000-03:00',
+    retries_to_perform: 1,
+    csid: 'YOURAPP',
+    page_header: '{Datedd/MM/yy} {TimeHHmmss} - https://www.webfax.me',
+    subject: "whatever",
+  )
+  if result > 0
+    puts "Success :)"
+  else
+    puts "Error :("
+  end
+end
+
+```
+
+## Contributing
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## License
+
+This code is released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).
+
+## Bugs, Issues, Thanks, etc
+
+Comments and feedbacks are welcome through project's [issue tracker](http://github.com/rafaelp/interfax-ruby/issues)
+
+## Author
+
+[**Rafael Lima**](http://github.com/rafaelp) working for [BielSystems](http://bielsystems.com.br)
+
+Blog: [http://rafael.adm.br](http://rafael.adm.br)
+
+Twitter: [http://twitter.com/rafaelp](http://twitter.com/rafaelp)
+
+### Did you like it?
+
+[Recommend me on Working With Rails](http://workingwithrails.com/recommendation/new/person/14248-rafael-lima)

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+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 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "interfax-ruby"
+  gem.homepage = "http://github.com/rafaelp/interfax-ruby"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby wrapper based on savon for Interfax SOAP API}
+  gem.description = %Q{Ruby wrapper based on savon for Interfax SOAP API}
+  gem.email = "contato@rafael.adm.br"
+  gem.authors = ["Rafael Lima"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "interfax-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/interfax-ruby.gemspec

@@ -0,0 +1,86 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "interfax-ruby"
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rafael Lima"]
+  s.date = "2013-03-14"
+  s.description = "Ruby wrapper based on savon for Interfax SOAP API"
+  s.email = "contato@rafael.adm.br"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "interfax-ruby.gemspec",
+    "lib/interfax.rb",
+    "spec/fixtures/mickey01.jpg",
+    "spec/fixtures/vcr_cassettes/cancel_file_upload.yml",
+    "spec/fixtures/vcr_cassettes/cancel_file_upload_with_session.yml",
+    "spec/fixtures/vcr_cassettes/sendfax_ex_2_authorized_default_values.yml",
+    "spec/fixtures/vcr_cassettes/sendfax_ex_2_authorized_required_values.yml",
+    "spec/fixtures/vcr_cassettes/start_file_upload_authorized.yml",
+    "spec/fixtures/vcr_cassettes/start_file_upload_unauthorized.yml",
+    "spec/fixtures/vcr_cassettes/upload_file_chunk_authorized.yml",
+    "spec/interfax_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/savon.rb",
+    "spec/support/vcr.rb"
+  ]
+  s.homepage = "http://github.com/rafaelp/interfax-ruby"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Ruby wrapper based on savon for Interfax SOAP API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<savon>, ["= 0.9.9"])
+      s.add_development_dependency(%q<ruby-debug19>, ["= 0.11.6"])
+      s.add_development_dependency(%q<rspec>, ["= 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["= 3.12"])
+      s.add_development_dependency(%q<bundler>, ["= 1.0.22"])
+      s.add_development_dependency(%q<jeweler>, ["= 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, ["= 0.5.3"])
+      s.add_development_dependency(%q<fakeweb>, ["= 1.3.0"])
+      s.add_development_dependency(%q<vcr>, ["= 1.11.3"])
+    else
+      s.add_dependency(%q<savon>, ["= 0.9.9"])
+      s.add_dependency(%q<ruby-debug19>, ["= 0.11.6"])
+      s.add_dependency(%q<rspec>, ["= 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["= 3.12"])
+      s.add_dependency(%q<bundler>, ["= 1.0.22"])
+      s.add_dependency(%q<jeweler>, ["= 1.8.3"])
+      s.add_dependency(%q<simplecov>, ["= 0.5.3"])
+      s.add_dependency(%q<fakeweb>, ["= 1.3.0"])
+      s.add_dependency(%q<vcr>, ["= 1.11.3"])
+    end
+  else
+    s.add_dependency(%q<savon>, ["= 0.9.9"])
+    s.add_dependency(%q<ruby-debug19>, ["= 0.11.6"])
+    s.add_dependency(%q<rspec>, ["= 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["= 3.12"])
+    s.add_dependency(%q<bundler>, ["= 1.0.22"])
+    s.add_dependency(%q<jeweler>, ["= 1.8.3"])
+    s.add_dependency(%q<simplecov>, ["= 0.5.3"])
+    s.add_dependency(%q<fakeweb>, ["= 1.3.0"])
+    s.add_dependency(%q<vcr>, ["= 1.11.3"])
+  end
+end
+

data/lib/interfax.rb

@@ -0,0 +1,81 @@
+require 'savon'
+require 'base64'
+
+class Interfax
+  WSDL_URL = "https://ws.interfax.net/dfs.asmx?WSDL"
+  def initialize(options = {})
+    @username = options[:username] || ENV['INTERFAX_USERNAME']
+    @password = options[:password] || ENV['INTERFAX_PASSWORD']
+    @raw_response = {}
+    @bytes_uploaded = 0
+    Gyoku.convert_symbols_to(:camelcase)
+  end
+
+  def client
+    @client ||= ::Savon::Client.new(WSDL_URL)
+  end
+
+  def start_file_upload
+    @last_session_id = request :start_file_upload do |response|
+      response[:session_id]
+    end
+  end
+
+  def upload_file_chunk(file_path, options = {})
+    chunk_size = options.delete(:chunk_size) || 200000
+    session_id = options.delete(:session_id) || @last_session_id || start_file_upload
+    @file_path = file_path
+
+    each_chunk(chunk_size) do |chunk, is_last|
+      request :upload_file_chunk, {
+        :chunk => Base64.encode64(chunk),
+        :SessionID => session_id,
+        :IsLast => is_last ? 1 : 0
+      } do |response, result|
+        @bytes_uploaded = result
+      end
+    end
+    return @bytes_uploaded == File.size(@file_path)
+  end
+
+  def cancel_file_upload(options = {})
+    session_id = options.delete(:session_id) || @last_session_id
+    return if session_id.nil?
+    request :cancel_file_upload, :session_id => session_id
+  end
+
+  def sendfax_ex_2(options = {})
+    default_options = {
+      :retries_to_perform => 1,
+      :page_size => 'A4',
+      :page_orientation => 'Portrait',
+      :is_high_resolution => false,
+      :is_fine_rendering => true,
+    }    
+    default_options.merge!(
+      :file_types => File.extname(@file_path)[1..4].upcase,
+      :file_sizes => "#{@bytes_uploaded}/sessionID=#{@last_session_id}"
+    ) unless @bytes_uploaded.zero?
+    options = default_options.merge(options)
+    options[:is_high_resolution] = options[:is_high_resolution] ? 1 : 0 unless options[:is_high_resolution].is_a? Integer
+    options[:is_fine_rendering] = options[:is_fine_rendering] ? 1 : 0 unless options[:is_fine_rendering].is_a? Integer
+    request :sendfax_ex_2, options
+  end
+
+  private
+  def request(method_name, options = {}, &block)
+    raw_response = client.request :int, method_name, {:body => {:username => @username, :password => @password}.merge(options)}
+    return false unless raw_response.success?
+    result = raw_response.to_hash["#{method_name}_response".to_sym]["#{method_name}_result".to_sym].to_i
+    response = raw_response.to_hash["#{method_name}_response".to_sym]
+    return result unless block_given?
+    yield response, result
+  end
+
+  # reads the given +file+ in chunks set though +chunk_size+ and yields
+  # the current chunk and whether it's the last chunk to iterate over.
+  def each_chunk(chunk_size)
+    File.open(@file_path, "rb") { |f| yield(f.read(chunk_size), f.eof?) until f.eof? }
+  end
+
+end

data/spec/fixtures/vcr_cassettes/cancel_file_upload.yml

@@ -0,0 +1,42 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :post
+    uri: https://ws.interfax.net:443/dfs.asmx
+    body: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:int="http://www.interfax.cc"
+      xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ins0="http://www.interfax.cc"
+      xmlns:ins1="http://www.interfax.cc/AbstractTypes"><env:Body><ins0:CancelFileUpload><int:Username>defaultusername</int:Username><int:Password>defaultpassword</int:Password><int:SessionId>2FE69E6C86DB4CB4926A94E63B68039AD83BCBB7F10C407F9641FEAEF5EA38EE</int:SessionId></ins0:CancelFileUpload></env:Body></env:Envelope>
+    headers:
+      soapaction:
+      - ! '"http://www.interfax.cc/CancelFileUpload"'
+      content-type:
+      - text/xml;charset=UTF-8
+      content-length:
+      - '592'
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Wed, 22 Feb 2012 23:56:41 GMT
+      server:
+      - Microsoft-IIS/6.0
+      iisexport:
+      - This web site was exported using IIS Export v4.2
+      - This web site was exported using IIS Export v4.2
+      x-powered-by:
+      - ASP.NET
+      x-aspnet-version:
+      - 2.0.50727
+      cache-control:
+      - private, max-age=0
+      content-type:
+      - text/xml; charset=utf-8
+      content-length:
+      - '380'
+    body: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><CancelFileUploadResponse
+      xmlns="http://www.interfax.cc"><CancelFileUploadResult>0</CancelFileUploadResult></CancelFileUploadResponse></soap:Body></soap:Envelope>
+    http_version: '1.1'