baby-braspag 0.1.6 → 0.2.1

data/RELEASES.md

@@ -1,5 +1,9 @@
 # RELEASES
 
+## 0.2.1 - 11/08/2014
+
+Log das operações `SaveCreditCard` e `JustClickShop` do serviço `CartaoProtegido`.
+
 ## For next release
 
 d2b9a7a Voltando a usar o HTTPI
@@ -17,4 +21,4 @@ a663e0a baixando a versão mínima requerida do nokogiri
 628d108 refatorando testes e implementação
 087549a moving Connection exceptions to errors.rb; tests for Utils class
 9a727eb bump up version
-6e5b1c3 refatorando para suportar o ambiente de produção da Braspag
+6e5b1c3 refatorando para suportar o ambiente de produção da Braspag

data/baby-braspag.gemspec

@@ -20,11 +20,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'httpi', '>= 0.9.6'
   s.add_dependency 'json', '>= 1.6.1'
-  s.add_dependency 'nokogiri', '>= 1.4.7'
-  s.add_dependency 'savon', '>= 0.9.9'
+  s.add_dependency 'nokogiri', '~> 1.6.1'
+  s.add_dependency 'savon', '~> 2.3.2'
 
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", '~> 2.12.0'
   s.add_development_dependency "fakeweb"
   s.add_development_dependency "shoulda-matchers"
   s.add_development_dependency "guard-rspec"

data/lib/baby-braspag.rb

@@ -42,4 +42,13 @@ module Braspag
   def self.proxy_address
     @proxy_address
   end
+
+  def self.savon_global_options=(options_hash)
+    @savon_global_options ||= {}
+    @savon_global_options.merge!(options_hash)
+  end
+
+  def self.savon_global_options
+    @savon_global_options || {}
+  end
 end

data/lib/baby-braspag/connection.rb

@@ -46,5 +46,12 @@ module Braspag
     def homologation?
       @environment == 'homologation'
     end
+
+    def savon_client(url, options = {})
+      options = options.merge(Braspag.savon_global_options)
+      options = options.merge(:proxy  => Braspag::proxy_address) if !Braspag::proxy_address.blank?
+      options = options.merge(:wsdl => url)
+      Savon.client(options)
+    end
   end
 end

data/lib/baby-braspag/payment_method.rb

@@ -18,6 +18,7 @@ module Braspag
       :amex_sitef               => 58,  # Amex SITEF
       :aura_dtef                => 37,  # Aura DTEF
       :redecard_sitef           => 44,  # Redecard SITEF - Mastercard/Diners
+      :amex_cielo               => 180,
       # MÉXICO
       :mex_amex_2p            => 45, # American Express 2 Party
       :mex_banorte_visa       => 50, # Banorte Visa

data/lib/baby-braspag/protected_credit_card.rb

@@ -40,14 +40,20 @@ module Braspag
         data['saveCreditCardRequestWS'][v] = params[k] || ""
       end
 
+      data_for_logging = data['saveCreditCardRequestWS'].dup
+      data_for_logging['CardNumber'] = "************%s" % data_for_logging['CardNumber'][-4..-1]
 
-     client = savon_client(self.save_protected_card_url)
-     response = client.request(:web, :save_credit_card) do
-       soap.body = data
-     end
+      Braspag.logger.info("[Braspag] #save_credit_card, data: #{data_for_logging}") if Braspag.logger
 
-      response.to_hash[:save_credit_card_response][:save_credit_card_result]
+      client = savon_client(self.save_protected_card_url)
+      response = client.call(:save_credit_card, :message => data)
+
+      # We do not want to let any sensitive data exposed on log files.
+      redacted_response = redact_just_click_key(response)
+
+      Braspag.logger.info("[Braspag] #save_credit_card returns: #{redacted_response}") if Braspag.logger
 
+      response.to_hash[:save_credit_card_response][:save_credit_card_result]
     end
 
     # request the credit card info in Braspag PCI Compliant
@@ -93,13 +99,18 @@ module Braspag
         end
       end
 
+      data_for_logging = data['justClickShopRequestWS'].dup
+      data_for_logging['SecurityCode'] = data_for_logging['SecurityCode'].gsub(/./, '*')
+      data_for_logging['JustClickKey'] = data_for_logging['JustClickKey'].gsub(/\h/, 'X')
+
+      Braspag.logger.info("[Braspag] #just_click_shop, data: #{data_for_logging}") if Braspag.logger
+
       client = savon_client(self.just_click_shop_url)
-      response = client.request(:web, :just_click_shop) do
-        soap.body = data
-      end
+      response = client.call(:just_click_shop, :message => data)
 
-      response.to_hash[:just_click_shop_response][:just_click_shop_result]
+      Braspag.logger.info("[Braspag] #just_click_shop returns: #{response}") if Braspag.logger
 
+      response.to_hash[:just_click_shop_response][:just_click_shop_result]
     end
 
     def self.check_protected_card_params(params)
@@ -151,10 +162,22 @@ module Braspag
       Braspag::Connection.instance.protected_card_url + JUST_CLICK_SHOP_URI
     end
 
-    def self.savon_client url
-      s = Savon::Client.new(url)
-      s.http.proxy = Braspag.proxy_address if Braspag.proxy_address
-      s
+    def self.savon_client(url)
+      Braspag::Connection.instance.savon_client url
+    end
+
+    # Internal: Redact the JustClickKey value from a XML response.
+    #
+    # response - the XML response string to be parsed.
+    #
+    # Example
+    #
+    #   redact_just_click_key('<JustClickKey>{070071E9-1F73-4C85-B1E4-D8040A627DED}</JustClickKey>')
+    #   # => '<JustClickKey>{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}</JustClickKey>'
+    #
+    # Returns a String.
+    def self.redact_just_click_key(response)
+      response.to_s.gsub(/(?<=<JustClickKey>)(.*?)(?=<\/JustClickKey>)/) { |key| key.gsub(/\h/, 'X') }
     end
   end
 end

data/lib/baby-braspag/version.rb

@@ -1,3 +1,3 @@
 module Braspag
-  VERSION = "0.1.6"
+  VERSION = "0.2.1"
 end

data/spec/connection_spec.rb

@@ -185,4 +185,54 @@ describe Braspag::Connection do
       end
     end
   end
+
+  describe "#savon_client" do
+    let(:wsdl_uri)        { 'http://localhost?wsdl' }
+    let(:proxy)           { nil }
+    let(:global_settings) { {} }
+
+    before do
+      Braspag.proxy_address = proxy
+      Braspag.savon_global_options = global_settings
+    end
+
+    context "with local setting" do
+      it "should set the settings on client" do
+        Savon.should_receive(:client).with(:wsdl => wsdl_uri, :logger_level => :info)
+
+        Braspag::Connection.clone.instance.savon_client(wsdl_uri, :logger_level => :info)
+      end
+    end
+
+    context "with proxy address set" do
+      let(:proxy) { 'http://some.proxy.com:3444' }
+
+      it "should set the proxy on client" do
+        Savon.should_receive(:client).with(:wsdl => wsdl_uri, :proxy => proxy)
+
+        Braspag::Connection.clone.instance.savon_client(wsdl_uri)
+      end
+    end
+
+    context "with global setting" do
+      let(:global_settings) { {:log => false} }
+
+      it "should set the settings on client" do
+        Savon.should_receive(:client).with(:wsdl => wsdl_uri, :log => false)
+
+        Braspag::Connection.clone.instance.savon_client(wsdl_uri)
+      end
+    end
+
+    context "with local setting, global settings and proxy" do
+      let(:proxy) { 'http://some.proxy.com:3444' }
+      let(:global_settings) { {:log => false} }
+
+      it "should set the settings and proxy on client" do
+        Savon.should_receive(:client).with(:wsdl => wsdl_uri, :proxy => proxy, :log => false, :logger_level => :info)
+
+        Braspag::Connection.clone.instance.savon_client(wsdl_uri, :logger_level => :info)
+      end
+    end
+  end
 end

data/spec/poster_spec.rb

@@ -37,6 +37,7 @@ describe Braspag::Poster do
     end
 
     it "should not set the proxy if the proxy_address is not set" do
+      Braspag.stub(:proxy_address)
       request.should_not_receive(:proxy=)
       subject.do_post(:foo, {})
     end

data/spec/protected_credit_card_spec.rb

@@ -10,20 +10,6 @@ describe Braspag::ProtectedCreditCard do
     Braspag::Connection.stub(:instance => @connection)
     Braspag.proxy_address = nil
   end
-  context "savon_client with proxy addres set" do
-    let (:savon_double) {double('Savon')}
-    before do
-      @http = double("HTTP")
-      Savon::Client.stub(:new).and_return savon_double
-      savon_double.stub(:http).and_return @http
-      Braspag.proxy_address = "http://some.proxy.com:3444"
-    end
-    it "should set the http proxy" do
-      @http.should_receive(:proxy=).with "http://some.proxy.com:3444"
-
-      Braspag::ProtectedCreditCard.savon_client("url")
-    end
-  end
 
   describe ".save" do
     let(:params) do
@@ -33,7 +19,7 @@ describe Braspag::ProtectedCreditCard do
         :card_number => "9" * 10,
         :expiration => "10/12",
         :order_id => "um order id",
-        :request_id => "00000000-0000-0000-0000-000000000044"
+        :request_id => "{D1BBDA27-65B9-4E68-9700-7A834A80BE88}"
       }
     end
 
@@ -42,19 +28,21 @@ describe Braspag::ProtectedCreditCard do
     end
 
     let(:save_protected_card_url) { "http://braspag.com/bla" }
-
     let(:savon_double) { double('Savon') }
+    let(:logger) { mock(:info => nil) }
 
     before do
+      Braspag.stub(:logger => logger)
       @connection.should_receive(:merchant_id)
     end
 
     context "with valid params" do
-      let(:valid_hash) do
+      let(:valid_response_hash) do
         {
           :save_credit_card_response => {
             :save_credit_card_result => {
-              :just_click_key => 'SAVE-PROTECTED-CARD-TOKEN',
+              :correlation_id => '{D1BBDA27-65B9-4E68-9700-7A834A80BE88}',
+              :just_click_key => '{070071E9-1F73-4C85-B1E4-D8040A627DED}',
               :success => true
             }
           }
@@ -62,27 +50,93 @@ describe Braspag::ProtectedCreditCard do
       end
 
       let(:response) do
-        double('Response', :to_hash => valid_hash)
+        xml_response = <<-XML
+          <?xml version="1.0" encoding="utf-8"?>
+          <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
+            <soap:Body>
+              <SaveCreditCardResponse xmlns="http://www.cartaoprotegido.com.br/WebService/">
+                <SaveCreditCardResult>
+                  <CorrelationId>{D1BBDA27-65B9-4E68-9700-7A834A80BE88}</CorrelationId>
+                  <JustClickKey>{070071E9-1F73-4C85-B1E4-D8040A627DED}</JustClickKey>
+                  <Success>true</Success>
+                </SaveCreditCardResult>
+              </SaveCreditCardResponse>
+            </soap:Body>
+          </soap:Envelope>
+        XML
+
+        double('Response', :to_s => xml_response, :to_hash => valid_response_hash)
       end
 
       before do
         Braspag::ProtectedCreditCard.should_receive(:save_protected_card_url)
         Braspag::ProtectedCreditCard.should_receive(:check_protected_card_params)
                            .and_return(true)
-        Savon::Client.should_receive(:new).and_return(savon_double)
-        savon_double.should_receive(:request).and_return(response)
-
-        @response = Braspag::ProtectedCreditCard.save(params)
+        @connection.should_receive(:savon_client).and_return(savon_double)
+        savon_double.should_receive(:call).and_return(response)
       end
 
       it "should return a Hash" do
+        @response = Braspag::ProtectedCreditCard.save(params)
+
         @response.should be_kind_of Hash
         @response.should == {
-          :just_click_key => "SAVE-PROTECTED-CARD-TOKEN",
+          :correlation_id => '{D1BBDA27-65B9-4E68-9700-7A834A80BE88}',
+          :just_click_key => '{070071E9-1F73-4C85-B1E4-D8040A627DED}',
           :success => true
         }
       end
 
+      it "should log that the save call was performed" do
+        Braspag.logger.should_receive(:info).with(%r{\[Braspag\] #save_credit_card, data:})
+
+        Braspag::ProtectedCreditCard.save(params)
+      end
+
+      [
+        %r{"RequestId"=>"{D1BBDA27-65B9-4E68-9700-7A834A80BE88}"},
+        %r{"MerchantKey"=>"um id qualquer"},
+        %r{"CustomerName"=>"WWWWWWWWWWWWWWWWWWWWW"},
+        %r{"CardHolder"=>"Joao Maria Souza"},
+        %r{"CardExpiration"=>"10/12"}
+      ].each do |request_param|
+        it "should log the request data with the #{request_param} parameter" do
+          Braspag.logger.should_receive(:info).with(request_param)
+
+          Braspag::ProtectedCreditCard.save(params)
+        end
+      end
+
+      it "should log the response received from to the save call" do
+        Braspag.logger.should_receive(:info)
+        Braspag.logger.should_receive(:info).with(%r{\[Braspag\] #save_credit_card returns:})
+
+        Braspag::ProtectedCreditCard.save(params)
+      end
+
+      [
+        %r{<CorrelationId>{D1BBDA27-65B9-4E68-9700-7A834A80BE88}</CorrelationId>},
+        %r{<JustClickKey>{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}</JustClickKey>},
+        %r{<Success>true</Success>}
+      ].each do |response_field|
+        it "should log the response with the #{response_field} field" do
+          Braspag.logger.should_receive(:info).with(response_field)
+
+          Braspag::ProtectedCreditCard.save(params)
+        end
+      end
+
+      it "should redact the given card number" do
+        Braspag.logger.should_receive(:info).with(%r{"CardNumber"=>"\*\*\*\*\*\*\*\*\*\*\*\*9999"})
+
+        Braspag::ProtectedCreditCard.save(params)
+      end
+
+      it "should redact the just click key value" do
+        Braspag.logger.should_receive(:info).with(%r{<JustClickKey>{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}<\/JustClickKey>})
+
+        Braspag::ProtectedCreditCard.save(params)
+      end
     end
 
     context "with invalid params" do
@@ -106,8 +160,8 @@ describe Braspag::ProtectedCreditCard do
                             .and_return(true)
         Braspag::ProtectedCreditCard.should_receive(:save_protected_card_url)
                             .and_return(save_protected_card_url)
-        Savon::Client.should_receive(:new).and_return(savon_double)
-        savon_double.should_receive(:request).and_return(response)
+        @connection.should_receive(:savon_client).and_return(savon_double)
+        savon_double.should_receive(:call).and_return(response)
 
         @response = Braspag::ProtectedCreditCard.save(params)
       end
@@ -151,9 +205,9 @@ describe Braspag::ProtectedCreditCard do
       EOXML
     end
 
-    before do
-      Braspag.logger.stub(:info)
-    end
+    let(:logger) { mock(:info => nil) }
+    before { Braspag.logger = logger }
+
     it "should raise an error when just click key is not valid" do
       Braspag::ProtectedCreditCard.should_receive(:valid_just_click_key?)
                          .with("bla")
@@ -204,84 +258,105 @@ describe Braspag::ProtectedCreditCard do
         :payment_method => :redecard,
         :number_installments => 3,
         :payment_type => "test",
-        :just_click_key => "key",
+        :just_click_key => "{070071E9-1F73-4C85-B1E4-D8040A627DED}",
         :security_code => "123"
       } }
 
+      let(:logger) { mock(:info => nil) }
+
       class SavonClientTest
         attr_accessor :response
         attr_reader :method
 
-        def request(web, method, &block)
-          @method = method
-          instance_eval &block
+        def call(method, options, &block)
+          @method  = method
+          @options = options
 
           @response
         end
 
-        def soap
-          @soap ||= OpenStruct.new
+        def options
+          OpenStruct.new(@options || {})
         end
       end
 
-      before :each do
+      before do
+        Braspag.stub(:logger => logger)
         @savon_client_test = SavonClientTest.new
         @savon_client_test.response = {:just_click_shop_response => {}}
-        Savon::Client.stub(:new).with('https://www.cartaoprotegido.com.br/Services/TestEnvironment/CartaoProtegido.asmx?wsdl').and_return(@savon_client_test)
+        @connection.should_receive(:savon_client).with('https://www.cartaoprotegido.com.br/Services/TestEnvironment/CartaoProtegido.asmx?wsdl').and_return(@savon_client_test)
       end
 
       after :each do
-        Savon::Client.unstub(:new)
       end
 
       it "should have RequestId" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['RequestId'].should eq '123'
+        @savon_client_test.options.message['justClickShopRequestWS']['RequestId'].should eq '123'
       end
 
       it "should have MerchantKey" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['MerchantKey'].should eq 'um id qualquer'
+        @savon_client_test.options.message['justClickShopRequestWS']['MerchantKey'].should eq 'um id qualquer'
       end
 
       it "should have CustomerName" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['CustomerName'].should eq 'Joao Silva'
+        @savon_client_test.options.message['justClickShopRequestWS']['CustomerName'].should eq 'Joao Silva'
       end
 
       it "should have OrderId" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['OrderId'].should eq '999'
+        @savon_client_test.options.message['justClickShopRequestWS']['OrderId'].should eq '999'
       end
 
       it "should have Amount" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['Amount'].should eq "1050"
+        @savon_client_test.options.message['justClickShopRequestWS']['Amount'].should eq "1050"
       end
 
       it "should have PaymentMethod" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['PaymentMethod'].should eq 20
+        @savon_client_test.options.message['justClickShopRequestWS']['PaymentMethod'].should eq 20
       end
 
       it "should have PaymentType" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['PaymentType'].should eq 'test'
+        @savon_client_test.options.message['justClickShopRequestWS']['PaymentType'].should eq 'test'
       end
 
       it "should have NumberInstallments" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['NumberInstallments'].should eq 3
+        @savon_client_test.options.message['justClickShopRequestWS']['NumberInstallments'].should eq 3
       end
 
       it "should have JustClickKey" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['JustClickKey'].should eq 'key'
+        @savon_client_test.options.message['justClickShopRequestWS']['JustClickKey'].should eq '{070071E9-1F73-4C85-B1E4-D8040A627DED}'
       end
 
       it "should have SecurityCode" do
         described_class.just_click_shop(params)
-        @savon_client_test.soap.body['justClickShopRequestWS']['SecurityCode'].should eq '123'
+        @savon_client_test.options.message['justClickShopRequestWS']['SecurityCode'].should eq '123'
+      end
+
+      it "should log the request data and the response body" do
+        Braspag.logger.should_receive(:info).with(%r{\[Braspag\] #just_click_shop, data:})
+        Braspag.logger.should_receive(:info).with(%r{\[Braspag\] #just_click_shop returns:})
+
+        described_class.just_click_shop(params)
+      end
+
+      it "should redact the given security code" do
+        Braspag.logger.should_receive(:info).with(%r{"SecurityCode"=>"\*\*\*"})
+
+        described_class.just_click_shop(params)
+      end
+
+      it "should redact the given security code" do
+        Braspag.logger.should_receive(:info).with(%r{"JustClickKey"=>"{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}"})
+
+        described_class.just_click_shop(params)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baby-braspag
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2014-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpi
@@ -48,33 +48,33 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 1.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: savon
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 2.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -96,17 +96,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.12.0
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
@@ -242,12 +242,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 818008938633395010
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 818008938633395010
 requirements: []
 rubyforge_project: baby-braspag
 rubygems_version: 1.8.25
@@ -266,4 +272,3 @@ test_files:
 - spec/protected_credit_card_spec.rb
 - spec/spec_helper.rb
 - spec/utils_spec.rb
-has_rdoc: