paypal-frete-facil 1.0.0 → 1.1.0

data/README.rdoc

@@ -5,7 +5,7 @@ Cálculo de frete através do PayPal Frete Fácil (http://www.paypal-brasil.com.
 == Instalando
 
 === Gemfile
-  gem 'paypal-frete-facil', '~> 0.2.2'
+  gem 'paypal-frete-facil'
 
 === Instalação direta
   $ gem install paypal-frete-facil
@@ -22,8 +22,25 @@ Cálculo de frete através do PayPal Frete Fácil (http://www.paypal-brasil.com.
                                         :profundidade => 30,
                                         :peso => 0.3
 
-  frete.calcular  # => 13.87
-  frete.calculate # => 13.87
+  resultado = frete.calcular
+  resultado.valor # => 14.77
+
+Verificação de sucesso e erro:
+
+  frete.altura = 200
+
+  resultado = frete.calcular
+  resultado.sucesso? # => false
+  resultado.erro?    # => true
+  resultado.msg_erro # => "Não foi possível calcular o frete."
+
+Usando a interface pública em inglês:
+
+  result = frete.calculate
+  result.value     # => 14.77
+  result.success?  # => true
+  result.error?    # => false
+  result.error_msg # => ""
 
 
 == Log
@@ -94,10 +111,16 @@ Para desabilitar o log, mudar o nível do log ou configurar um outro mecanismo d
 ==== String
   cep_origem, cep_destino
 ==== Fixnum
-  largura, altura, profundidade
+  largura, altura, profundidade (comprimento)
 ==== Float
   peso
 
+
+=== Outros detalhes da classe PayPal::FreteFacil::Frete
+* Os atributos *profundidade* e *comprimento* são a mesma coisa, configurando um irá configurar também o outro.
+* Os atributos *largura*, *altura* e *profundidade* também aceitam valores com casas decimais (<em>float</em>), mas para fazer o cálculo será feito um <em>round</em> de seus valores.
+
+
 == Copyright
 
 (The MIT License)

data/lib/paypal-frete-facil.rb

@@ -3,4 +3,5 @@ require 'rubygems'
 require 'paypal/fretefacil'
 require 'paypal/fretefacil/frete'
 require 'paypal/fretefacil/parser'
+require 'paypal/fretefacil/resultado'
 require 'paypal/fretefacil/web_service'

data/lib/paypal/fretefacil/frete.rb

@@ -6,6 +6,9 @@ module PayPal
       attr_accessor :largura, :altura, :profundidade
       attr_accessor :peso
 
+      alias comprimento  profundidade
+      alias comprimento= profundidade=
+
       DEFAULT_OPTIONS = {
         :largura => 0,
         :altura => 0,
@@ -31,7 +34,8 @@ module PayPal
 
       def calcular
         response = web_service.request!
-        parser.parse(response)
+        value = parser.parse(response)
+        PayPal::FreteFacil::Resultado.new(value)
       end
 
       alias calculate calcular

data/lib/paypal/fretefacil/parser.rb

@@ -5,8 +5,7 @@ module PayPal
   module FreteFacil
     class Parser
       def parse(xml)
-        value = Nokogiri::XML(xml).xpath("//return").text.to_f
-        Float.instance_method(:round).arity.zero? ? value : value.round(2)
+        Nokogiri::XML(xml).xpath("//return").text.to_f
       end
     end
   end

data/lib/paypal/fretefacil/resultado.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+module PayPal
+  module FreteFacil
+    class Resultado
+      attr_reader :valor
+      alias value valor
+
+      def initialize(valor)
+        if valor > 0
+          # Ruby 1.8.7 compatibility.
+          @valor = Float.instance_method(:round).arity.zero? ? valor : valor.round(2)
+        else
+          @valor = 0
+          @erro = true
+          @msg_erro = "Não foi possível calcular o frete."
+        end
+      end
+
+      def sucesso?
+        !erro?
+      end
+      alias success? sucesso?
+
+      def erro?
+        @erro ||= false
+      end
+      alias error? erro?
+
+      def msg_erro
+        @msg_erro ||= ""
+      end
+      alias error_msg msg_erro
+    end
+  end
+end

data/lib/paypal/fretefacil/version.rb

@@ -3,7 +3,7 @@ module PayPal
   module FreteFacil
     module Version
       MAJOR = 1
-      MINOR = 0
+      MINOR = 1
       PATCH = 0
       VERSION = [MAJOR, MINOR, PATCH].join(".")
     end

data/lib/paypal/fretefacil/web_service.rb

@@ -48,9 +48,9 @@ module PayPal
             "<frete:getPreco>" +
               "<cepOrigem>#{@frete.cep_origem}</cepOrigem>" +
               "<cepDestino>#{@frete.cep_destino}</cepDestino>" +
-              "<largura>#{@frete.largura}</largura>" +
-              "<altura>#{@frete.altura}</altura>" +
-              "<profundidade>#{@frete.profundidade}</profundidade>" +
+              "<largura>#{@frete.largura.round}</largura>" +
+              "<altura>#{@frete.altura.round}</altura>" +
+              "<profundidade>#{@frete.profundidade.round}</profundidade>" +
               "<peso>#{@frete.peso}</peso>" +
             "</frete:getPreco>" +
           "</soapenv:Body>" +

data/paypal-frete-facil.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "paypal-frete-facil"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Prodis a.k.a. Fernando Hamasaki"]
-  s.date = "2012-05-08"
+  s.date = "2012-05-10"
   s.description = "Calculo de frete atraves do PayPal Frete Facil (http://www.paypal-brasil.com.br/fretefacil)."
   s.email = "prodis@gmail.com"
   s.extra_rdoc_files = [
@@ -26,11 +26,13 @@ Gem::Specification.new do |s|
     "lib/paypal/fretefacil.rb",
     "lib/paypal/fretefacil/frete.rb",
     "lib/paypal/fretefacil/parser.rb",
+    "lib/paypal/fretefacil/resultado.rb",
     "lib/paypal/fretefacil/version.rb",
     "lib/paypal/fretefacil/web_service.rb",
     "paypal-frete-facil.gemspec",
     "spec/paypal/fretefacil/frete_spec.rb",
     "spec/paypal/fretefacil/parser_spec.rb",
+    "spec/paypal/fretefacil/resultado_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/fake_request.rb",
     "spec/support/responses/success_response.xml"

data/spec/paypal/fretefacil/frete_spec.rb

@@ -9,6 +9,7 @@ describe PayPal::FreteFacil::Frete do
       { :largura => 0,
         :altura => 0,
         :profundidade => 0,
+        :comprimento => 0,
         :peso => 0.0
       }.each do |attr, value|
         it attr do
@@ -22,6 +23,7 @@ describe PayPal::FreteFacil::Frete do
       :largura => 15,
       :altura => 2,
       :profundidade => 30,
+      :comprimento => 30,
       :peso => 0.321
     }.each do |attr, value|
       context "when #{attr} is supplied" do
@@ -48,10 +50,10 @@ describe PayPal::FreteFacil::Frete do
         PayPal::FreteFacil.configure { |config| config.log_enabled = true }
       end
       
-      it "returns shipping price" do
+      it "returns shipping price result" do
         fake_request(10.23)
         frete = PayPal::FreteFacil::Frete.new
-        frete.send(method_name).should == 10.23
+        frete.send(method_name).valor.should == 10.23
       end
     end
   end

data/spec/paypal/fretefacil/parser_spec.rb

@@ -7,15 +7,8 @@ describe PayPal::FreteFacil::Parser do
 
     context "when XML is correct" do
       it "returns shipping price" do
-        xml = response_body(8.19)
-        parser.parse(xml).should == 8.19
-      end
-
-      context "and shipping price has more then two decimal places" do
-        it "returns shipping price rounded to two decimal places" do
-          xml = response_body(8.2261234567)
-          parser.parse(xml).should == 8.23
-        end
+        xml = response_body(8.2261234567)
+        parser.parse(xml).should == 8.2261234567
       end
     end
 

data/spec/paypal/fretefacil/resultado_spec.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe PayPal::FreteFacil::Resultado do
+  describe ".new" do
+    context "when shipping value is valid" do
+      let(:resultado) { PayPal::FreteFacil::Resultado.new(13.87) }
+
+      it "shipping value is the valid value" do
+        resultado.valor.should == 13.87
+      end
+
+      it "result is successful" do
+        resultado.sucesso?.should be_true
+      end
+
+      it "there is not error" do
+        resultado.erro?.should be_false  
+      end
+
+      it "there is not error message" do
+        resultado.msg_erro.should be_empty
+      end
+
+      context "and has more than two decimal places"  do
+        it "rounds shipping value to two decimal places" do
+          resultado = PayPal::FreteFacil::Resultado.new(8.2261234567)
+          resultado.valor.should == 8.23
+        end
+      end
+    end
+
+    context "when value is not valid" do
+      [0, -12, -15.8].each do |value|
+        context "as #{value}" do
+          let(:resultado) { PayPal::FreteFacil::Resultado.new(value) }
+
+          it "valor is zero" do
+            resultado.valor.should be_zero
+          end
+
+          it "result is not successful" do
+            resultado.sucesso?.should be_false
+          end
+
+          it "there is error" do
+            resultado.erro?.should be_true
+          end
+
+          it "there is error message" do
+            resultado.msg_erro.should == "Não foi possível calcular o frete."
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paypal-frete-facil
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000 Z
+date: 2012-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log-me
-  requirement: &11293900 !ruby/object:Gem::Requirement
+  requirement: &11805370 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *11293900
+  version_requirements: *11805370
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &11293000 !ruby/object:Gem::Requirement
+  requirement: &11805130 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *11293000
+  version_requirements: *11805130
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &11291920 !ruby/object:Gem::Requirement
+  requirement: &11804890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *11291920
+  version_requirements: *11804890
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &11290900 !ruby/object:Gem::Requirement
+  requirement: &11821020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.8'
   type: :development
   prerelease: false
-  version_requirements: *11290900
+  version_requirements: *11821020
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11289970 !ruby/object:Gem::Requirement
+  requirement: &11820780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *11289970
+  version_requirements: *11820780
 - !ruby/object:Gem::Dependency
   name: ruby-debug
-  requirement: &11289380 !ruby/object:Gem::Requirement
+  requirement: &11820540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11289380
+  version_requirements: *11820540
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &11304950 !ruby/object:Gem::Requirement
+  requirement: &11820300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11304950
+  version_requirements: *11820300
 description: Calculo de frete atraves do PayPal Frete Facil (http://www.paypal-brasil.com.br/fretefacil).
 email: prodis@gmail.com
 executables: []
@@ -105,11 +105,13 @@ files:
 - lib/paypal/fretefacil.rb
 - lib/paypal/fretefacil/frete.rb
 - lib/paypal/fretefacil/parser.rb
+- lib/paypal/fretefacil/resultado.rb
 - lib/paypal/fretefacil/version.rb
 - lib/paypal/fretefacil/web_service.rb
 - paypal-frete-facil.gemspec
 - spec/paypal/fretefacil/frete_spec.rb
 - spec/paypal/fretefacil/parser_spec.rb
+- spec/paypal/fretefacil/resultado_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_request.rb
 - spec/support/responses/success_response.xml