interfax-ruby 0.1.2

data/spec/interfax_spec.rb

@@ -0,0 +1,208 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Interfax" do
+  let(:session_id) { "D32EFA4297184BDF92A8393CB891F137B758A945F1D54E48869046799928C965" }
+  let(:file_name) { File.join('spec','fixtures','mickey01.jpg') }
+  before(:each) do
+    ENV['INTERFAX_USERNAME'] = 'defaultusername'
+    ENV['INTERFAX_PASSWORD'] = 'defaultpassword'
+  end
+  let(:interfax) { Interfax.new }
+  context "username and password is not passed" do
+    let(:interfax) { Interfax.new }
+    it "should store username and password from environment variables" do
+      interfax.instance_variable_get(:@username).should == 'defaultusername'
+      interfax.instance_variable_get(:@password).should == 'defaultpassword'
+    end
+  end
+  context "username and password is passed" do
+    let(:interfax) { Interfax.new(:username => 'myusername', :password => 'mypassword') }
+    it "should store username and password from values passed" do
+      interfax.instance_variable_get(:@username).should == 'myusername'
+      interfax.instance_variable_get(:@password).should == 'mypassword'
+    end
+  end
+  it "should have WSDL_URL" do
+    Interfax::WSDL_URL.should == "https://ws.interfax.net/dfs.asmx?WSDL"
+  end
+  describe "#client" do
+    it "should return savon client" do
+      interfax.client.should be_kind_of(Savon::Client)
+    end
+    it "should have correct document" do
+      interfax.client.wsdl.document.should == "https://ws.interfax.net/dfs.asmx?WSDL"
+    end
+  end
+  describe "#start_file_upload" do
+    context "authorized" do
+      let(:interfax) { Interfax.new(:username => 'rafael_lima', :password => ENV['INTERFAX_PASSWORD_FOR_RSPEC']) }
+      it "should assign last_session_id" do
+        VCR.use_cassette('start_file_upload_authorized') do
+          interfax.start_file_upload
+          interfax.instance_variable_get(:@last_session_id).should == session_id
+        end
+      end
+      it "should return session id" do
+        VCR.use_cassette('start_file_upload_authorized') do
+          interfax.start_file_upload.should == session_id
+        end
+      end
+      it "should not cache session id" do
+        interfax.client.should_receive(:request).twice.and_return(mock("Response", :success? => true, :to_hash => {:start_file_upload_response => {:start_file_upload_result => "1", :session_id => "2FE69E6C86DB4CB4926A94E63B68039AD83BCBB7F10C407F9641FEAEF5EA38EE"}}))
+        VCR.use_cassette('start_file_upload_authorized') do
+          2.times { interfax.start_file_upload }
+        end
+      end
+    end
+    context "unauthorized" do
+      it "should return false" do
+        VCR.use_cassette('start_file_upload_unauthorized') do
+          interfax.start_file_upload.should be_nil
+        end
+      end
+      it "should not assign last_session_id" do
+        VCR.use_cassette('start_file_upload_unauthorized') do
+          interfax.start_file_upload
+          interfax.instance_variable_get(:@last_session_id).should be_nil
+        end
+      end
+    end
+  end
+  describe "#upload_file_chunk" do
+    context "start_file_upload was not called" do
+      context "session id is not passed" do
+        it "should call start_file_upload" do
+          interfax.should_receive(:start_file_upload)
+          interfax.stub(:request)
+          interfax.upload_file_chunk(file_name)
+        end
+      end
+      context "session id is passed" do
+        it "should not call start_file_upload" do
+          interfax.should_not_receive(:start_file_upload)
+          interfax.stub(:request)
+          interfax.upload_file_chunk(file_name, :session_id => session_id)
+        end
+        it "should call request with correct params" do
+          interfax.should_receive(:request).with(:upload_file_chunk, {
+            :chunk => anything(),
+            :SessionID => session_id,
+            :IsLast => 1
+          })
+          interfax.upload_file_chunk(file_name, :session_id => session_id)        
+        end
+        
+      end
+    end
+    context "start_file_upload was called before" do
+      before(:each) do
+        VCR.use_cassette('start_file_upload_authorized') do
+          interfax.start_file_upload
+        end
+      end
+      it "should not call start_file_upload" do
+        interfax.should_not_receive(:start_file_upload)
+        interfax.stub(:request)
+        interfax.upload_file_chunk(file_name)
+      end
+      context "authorized" do
+        let(:interfax) { Interfax.new(:username => 'rafael_lima', :password => ENV['INTERFAX_PASSWORD_FOR_RSPEC']) }
+        it "should return true" do
+          VCR.use_cassette('upload_file_chunk_authorized') do
+            interfax.upload_file_chunk(file_name, :chunk_size => 40960).should be_true
+          end
+        end
+        it "should request twice" do
+          interfax.client.should_receive(:request).twice.and_return(mock("Response", :success? => true, :to_hash => {:upload_file_chunk_response => {:upload_file_chunk_result => "68702"}}))
+          interfax.upload_file_chunk(file_name, :chunk_size => 40960).should be_true
+        end
+      end
+    end
+  end
+  describe "#cancel_file_upload" do
+    context "start_file_upload was not successfully called" do
+      context "session id is not passed" do
+        it "should return nil" do
+          interfax.cancel_file_upload.should be_nil
+        end
+      end
+      context "session id is passed" do
+        it "should return true" do
+          VCR.use_cassette('cancel_file_upload_with_session') do
+            interfax.cancel_file_upload(:session_id => session_id).should == 0
+          end
+        end
+      end
+    end
+    context "start_file_upload was successfully called" do
+      before(:each) do
+        VCR.use_cassette('start_file_upload_authorized') do
+          interfax.start_file_upload
+        end
+      end
+      it "should return true" do
+        VCR.use_cassette('cancel_file_upload') do
+          interfax.cancel_file_upload.should == 0
+        end
+      end
+    end
+  end
+  describe "#sendfax_ex_2" do
+    context "authorized" do
+      let(:interfax) { Interfax.new(:username => 'rafael_lima', :password => ENV['INTERFAX_PASSWORD_FOR_RSPEC']) }
+      context "with file uploaded" do
+        before(:each) do
+          VCR.use_cassette('start_file_upload_authorized') do
+            interfax.start_file_upload
+          end
+          VCR.use_cassette('upload_file_chunk_authorized') do
+            interfax.upload_file_chunk(file_name, :chunk_size => 40960).should be_true
+          end
+        end
+        it "should set default values" do
+          interfax.should_receive(:request).with(:sendfax_ex_2, {
+            :file_types => 'JPG',
+            :file_sizes => "68702/sessionID=#{session_id}",
+            :retries_to_perform => 1,
+            :page_size => 'A4',
+            :page_orientation => 'Portrait',
+            :is_high_resolution => 0,
+            :is_fine_rendering => 1,
+          })
+          interfax.sendfax_ex_2
+        end
+      end
+      context "without file uploaded" do
+        it "should set default values" do
+          interfax.should_receive(:request).with(:sendfax_ex_2, {
+            :retries_to_perform => 1,
+            :page_size => 'A4',
+            :page_orientation => 'Portrait',
+            :is_high_resolution => 0,
+            :is_fine_rendering => 1,
+          })
+          interfax.sendfax_ex_2
+        end
+      end
+      context "with default values" do
+        it "should return error code" do
+          VCR.use_cassette('sendfax_ex_2_authorized_default_values') do
+            interfax.sendfax_ex_2.should == -1007
+          end
+        end
+      end
+      context "with required values" do
+        it "should return error code" do
+          VCR.use_cassette('sendfax_ex_2_authorized_required_values') do
+            interfax.sendfax_ex_2({
+              :fax_numbers => '+55-21-35531898',
+              :files_data => Base64.encode64(File.read(file_name)),
+              :file_types => 'JPG',
+              :file_sizes => File.size(file_name),
+            }).should == 257489542
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'interfax'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/savon.rb

@@ -0,0 +1,3 @@
+Savon.configure do |config|
+  config.log = false            # disable logging
+end

data/spec/support/vcr.rb

@@ -0,0 +1,6 @@
+require 'vcr'
+
+VCR.config do |c|
+  c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
+  c.stub_with :fakeweb
+end

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: interfax-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Rafael Lima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.22
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.22
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.11.3
+description: Ruby wrapper based on savon for Interfax SOAP API
+email: contato@rafael.adm.br
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+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
+homepage: http://github.com/rafaelp/interfax-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1231871281370402405
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper based on savon for Interfax SOAP API
+test_files: []