tray-checkout 0.2.1 → 0.3.0

data/README.rdoc

@@ -1,6 +1,8 @@
 = tray-checkout
 
-Tray Checkout API
+Library to provide access to TrayCheckout's API.
+
+Note: This version is not compatible with the 0.2.1, for the new API version (v2) is not compatible with the old (v1).
 
 == Installing
 
@@ -130,6 +132,52 @@ Creating a successful transaction:
   response.customer[:email] # => "pedro@bo.com.br"
   response.customer[:cpf]   # => "18565842673"
 
+=== Temp Transactions (Carts)
+
+You can create or update carts through the Tray::Checkout::TempTransaction class:
+
+  temp_transaction = Tray::Checkout::TempTransaction.new
+  temp_transaction.add_to_cart(
+    token_account: "8bfe5ddcb77107b",
+    postal_code_seller: "18524698",
+    transaction: {
+      order_number: "1234567",
+      free: "Texto Interno",
+      url_notification: "http://prodis.blog.br/tray_notification",
+      products: [
+        {
+          code: "teste",
+          description: "Notebook Branco",
+          quantity: "1",
+          price_unit: "2199.99",
+          weight: "300",
+          url_img: "http://catnross.com/wp-content/uploads/2011/08/product1.jpg"
+        }
+      ]
+    }
+  )
+  response.success? # => true
+
+  response[:token]   # => a906bf32cb59060dfc90769524f99d4a
+  response[:url_car] # => http://checkout.sandbox.tray.com.br/payment/car/v1/
+
+  # Products
+  response[:products].first[:code]         # => teste
+  response[:products].first[:img]          # => http://catnross.com/wp-content/uploads/2011/08/product1.jpg
+  response[:products].first[:sku_code]     # => nil
+  response[:products].first[:description]  # => Notebook Branco
+  response[:products].first[:extra]        # => nil
+  response[:products].first[:price_unit]   # => 2199.99
+  response[:products].first[:quantity]     # => 1.0
+  response[:products].first[:weight]       # => 300.0
+  response[:products].first[:id]           # => 4502
+  response[:products].first[:type_product] # => nil
+
+After creating a cart you can forward your client using the cart_url method:
+
+  temp_transaction = Tray::Checkout::TempTransaction.new
+  temp_transaction.add_to_cart # => http://checkout.sandbox.tray.com.br/payment/car/v1/a906bf32cb59060dfc90769524f99d4a
+
 == Configurations
 
 === Environment
@@ -162,97 +210,63 @@ For default, each request to Tray Checkout API is logged to STDOUT, with <b>:inf
 
 Log example:
   I, [2013-01-11T00:55:10.531780 #22692]  INFO -- : Tray-Checkout Request:
-  POST http://api.sandbox.checkout.tray.com.br/api/v1/transactions/get_by_token
+  POST http://api.sandbox.traycheckout.com.br//v2/transactions/get_by_token
   token=522045453u5uu32e0u8014f060uuu5uu
 
   I, [2013-01-11T00:55:10.750308 #22692]  INFO -- : Tray-Checkout Response:
   HTTP/1.1 200 OK
   <?xml version="1.0" encoding="UTF-8"?>
-  <transaction>
+  <response>
     <data_response>
       <transaction>
-        <order_number>F4326</order_number>
-        <free nil="true"/>
-        <transaction_id type="integer">632</transaction_id>
-        <status_name>Aguardando Pagamento</status_name>
-        <status_id type="integer">4</status_id>
-        <date_transaction>2012-12-27T10:26:21</date_transaction>
-        <split type="integer">1</split>
-        <price_payment type="decimal">37.86</price_payment>
-        <date_payment></date_payment>
-        <transaction_token>522045453u5uu32e0u8014f060uuu5uu</transaction_token>
-        <sub_store nil="true"/>
-        <available_payment_methods nil="true"/>
-        <url_notification>http://prodis.blog.br/tray_notification</url_notification>
-        <url_css nil="true"/>
-        <url_shipping nil="true"/>
-        <url_stock nil="true"/>
-        <url_success nil="true"/>
-        <url_process nil="true"/>
-        <url_cancel nil="true"/>
-        <schedule_credit></schedule_credit>
-        <price_seller type="decimal">35.05</price_seller>
-        <price_original type="decimal">37.86</price_original>
-        <price_additional type="decimal">0.0</price_additional>
-        <price_discount type="decimal">0.0</price_discount>
-        <shipping_price type="decimal">5.88</shipping_price>
-        <shipping_type>PAC</shipping_type>
+        <order_number>1234567</order_number>
+        <free>Texto Interno</free>
+        <transaction_id type="integer">3856</transaction_id>
+        <status_name>Em Recupera\xC3\xA7\xC3\xA3o</status_name>
+        <status_id type="integer">88</status_id>
+        <token_transaction>522045453u5uu32e0u8014f060uuu5uu</token_transaction>
         <payment>
-          <price_payment type="decimal">37.86</price_payment>
+          <price_original type="decimal">2199.99</price_original>
+          <price_payment type="decimal">2199.99</price_payment>
           <payment_response></payment_response>
-          <url_payment>http://checkout.sandbox.tray.com.br/payment/billet/u9uuu8731319u59u3073u9011uu6u6uu</url_payment>
-          <date_approval></date_approval>
-          <tid></tid>
+          <url_payment>http://gtw.sandbox.checkout.tray.com.br/api/print/0b525e9dbef558690477b815118aa033</url_payment>
+          <tid nil="true"/>
           <split type="integer">1</split>
-          <date_payment></date_payment>
           <payment_method_id type="integer">6</payment_method_id>
           <payment_method_name>Boleto Bancario</payment_method_name>
-          <card_id nil="true"/>
-          <number_proccess type="integer">869</number_proccess>
-          <linha_digitavel>34191.76007 00086.950144 50565.600009 1 55650000003786</linha_digitavel>
+          <linha_digitavel>34191.76007 00536.260144 50565.600009 6 58630000219999</linha_digitavel>
         </payment>
-        <products type="array">
-          <product>
-            <code>LOGO-8278</code>
-            <description>Logo Prodis</description>
-            <extra nil="true"/>
-            <price_unit type="decimal">10.99</price_unit>
-            <quantity type="decimal">2.0</quantity>
-            <sku_code nil="true"/>
-            <url_img nil="true"/>
-          </product>
-          <product>
-            <code>877</code>
-            <description>Outro produto</description>
-            <extra nil="true"/>
-            <price_unit type="decimal">10.0</price_unit>
-            <quantity type="decimal">1.0</quantity>
-            <sku_code nil="true"/>
-            <url_img nil="true"/>
-          </product>
-        </products>
-        <transaction_affiliates type="array"/>
         <customer>
-          <name>Pedro Bonamides</name>
-          <cpf>18565842673</cpf>
-          <email>pedro@bo.com.br</email>
+          <name>Nome do Cliente</name>
+          <cpf>98489882380</cpf>
+          <email>emaildo@cliente.com.br</email>
+          <company_name></company_name>
+          <trade_name></trade_name>
+          <cnpj></cnpj>
           <addresses type="array">
             <address>
-              <street>Avenida Pedro Alvares Cabral</street>
-              <number>123</number>
-              <neighborhood>Parque Ibirapuera</neighborhood>
-              <postal_code>04094050</postal_code>
+              <street>Av Paulista</street>
+              <number>1001</number>
+              <neighborhood>Centro</neighborhood>
+              <postal_code>04001001</postal_code>
+              <completion></completion>
+              <city>S\xC3\xA3o Paulo</city>
+              <state>SP</state>
+            </address>
+            <address>
+              <street>Av Paulista</street>
+              <number>1001</number>
+              <neighborhood>Centro</neighborhood>
+              <postal_code>04001001</postal_code>
               <completion></completion>
-              <city>São Paulo</city>
+              <city>S\xC3\xA3o Paulo</city>
               <state>SP</state>
             </address>
           </addresses>
           <contacts type="array">
             <contact>
-              <contact_id type="integer">345</contact_id>
-              <value>1137654321</value>
-              <type_contact>H</type_contact>
-              <primary type="boolean">true</primary>
+              <value>11998761234</value>
+              <type_contact>M</type_contact>
             </contact>
           </contacts>
         </customer>
@@ -261,11 +275,13 @@ Log example:
     <message_response>
       <message>success</message>
     </message_response>
-  </transaction>
+  </response>
+
+
 
 If you configure log level to <b>:debug</b>, request and response HTTP headers will be logged too.
   D, [2013-01-11T00:58:56.226742 #22692] DEBUG -- : Tray-Checkout Request:
-  POST http://api.sandbox.checkout.tray.com.br/api/v1/transactions/get_by_token
+  POST http://api.sandbox.traycheckout.com.br//v2/transactions/get_by_token
   accept: */*
   user-agent: Ruby
   token=522045453u5uu32e0u8014f060uuu5uu
@@ -286,91 +302,57 @@ If you configure log level to <b>:debug</b>, request and response HTTP headers w
   x-rack-cache: invalidate, pass
   server: nginx/1.2.5 + Phusion Passenger 3.0.18 (mod_rails/mod_rack)
   <?xml version="1.0" encoding="UTF-8"?>
-  <transaction>
+  <response>
     <data_response>
       <transaction>
-        <order_number>F4326</order_number>
-        <free nil="true"/>
-        <transaction_id type="integer">632</transaction_id>
-        <status_name>Aguardando Pagamento</status_name>
-        <status_id type="integer">4</status_id>
-        <date_transaction>2012-12-27T10:26:21</date_transaction>
-        <split type="integer">1</split>
-        <price_payment type="decimal">37.86</price_payment>
-        <date_payment></date_payment>
-        <transaction_token>522045453u5uu32e0u8014f060uuu5uu</transaction_token>
-        <sub_store nil="true"/>
-        <available_payment_methods nil="true"/>
-        <url_notification>http://prodis.blog.br/tray_notification</url_notification>
-        <url_css nil="true"/>
-        <url_shipping nil="true"/>
-        <url_stock nil="true"/>
-        <url_success nil="true"/>
-        <url_process nil="true"/>
-        <url_cancel nil="true"/>
-        <schedule_credit></schedule_credit>
-        <price_seller type="decimal">35.05</price_seller>
-        <price_original type="decimal">37.86</price_original>
-        <price_additional type="decimal">0.0</price_additional>
-        <price_discount type="decimal">0.0</price_discount>
-        <shipping_price type="decimal">5.88</shipping_price>
-        <shipping_type>PAC</shipping_type>
+        <order_number>1234567</order_number>
+        <free>Texto Interno</free>
+        <transaction_id type="integer">3856</transaction_id>
+        <status_name>Em Recupera\xC3\xA7\xC3\xA3o</status_name>
+        <status_id type="integer">88</status_id>
+        <token_transaction>522045453u5uu32e0u8014f060uuu5uu</token_transaction>
         <payment>
-          <price_payment type="decimal">37.86</price_payment>
+          <price_original type="decimal">2199.99</price_original>
+          <price_payment type="decimal">2199.99</price_payment>
           <payment_response></payment_response>
-          <url_payment>http://checkout.sandbox.tray.com.br/payment/billet/u9uuu8731319u59u3073u9011uu6u6uu</url_payment>
-          <date_approval></date_approval>
-          <tid></tid>
+          <url_payment>http://gtw.sandbox.checkout.tray.com.br/api/print/0b525e9dbef558690477b815118aa033</url_payment>
+          <tid nil="true"/>
           <split type="integer">1</split>
-          <date_payment></date_payment>
           <payment_method_id type="integer">6</payment_method_id>
           <payment_method_name>Boleto Bancario</payment_method_name>
-          <card_id nil="true"/>
-          <number_proccess type="integer">869</number_proccess>
-          <linha_digitavel>34191.76007 00086.950144 50565.600009 1 55650000003786</linha_digitavel>
+          <linha_digitavel>34191.76007 00536.260144 50565.600009 6 58630000219999</linha_digitavel>
         </payment>
-        <products type="array">
-          <product>
-            <code>LOGO-8278</code>
-            <description>Logo Prodis</description>
-            <extra nil="true"/>
-            <price_unit type="decimal">10.99</price_unit>
-            <quantity type="decimal">2.0</quantity>
-            <sku_code nil="true"/>
-            <url_img nil="true"/>
-          </product>
-          <product>
-            <code>877</code>
-            <description>Outro produto</description>
-            <extra nil="true"/>
-            <price_unit type="decimal">10.0</price_unit>
-            <quantity type="decimal">1.0</quantity>
-            <sku_code nil="true"/>
-            <url_img nil="true"/>
-          </product>
-        </products>
-        <transaction_affiliates type="array"/>
         <customer>
-          <name>Pedro Bonamides</name>
-          <cpf>18565842673</cpf>
-          <email>pedro@bo.com.br</email>
+          <name>Nome do Cliente</name>
+          <cpf>98489882380</cpf>
+          <email>emaildo@cliente.com.br</email>
+          <company_name></company_name>
+          <trade_name></trade_name>
+          <cnpj></cnpj>
           <addresses type="array">
             <address>
-              <street>Avenida Pedro Alvares Cabral</street>
-              <number>123</number>
-              <neighborhood>Parque Ibirapuera</neighborhood>
-              <postal_code>04094050</postal_code>
+              <street>Av Paulista</street>
+              <number>1001</number>
+              <neighborhood>Centro</neighborhood>
+              <postal_code>04001001</postal_code>
+              <completion></completion>
+              <city>S\xC3\xA3o Paulo</city>
+              <state>SP</state>
+            </address>
+            <address>
+              <street>Av Paulista</street>
+              <number>1001</number>
+              <neighborhood>Centro</neighborhood>
+              <postal_code>04001001</postal_code>
               <completion></completion>
-              <city>São Paulo</city>
+              <city>S\xC3\xA3o Paulo</city>
               <state>SP</state>
             </address>
           </addresses>
           <contacts type="array">
             <contact>
-              <contact_id type="integer">345</contact_id>
-              <value>1137654321</value>
-              <type_contact>H</type_contact>
-              <primary type="boolean">true</primary>
+              <value>11998761234</value>
+              <type_contact>M</type_contact>
             </contact>
           </contacts>
         </customer>
@@ -379,7 +361,7 @@ If you configure log level to <b>:debug</b>, request and response HTTP headers w
     <message_response>
       <message>success</message>
     </message_response>
-  </transaction>
+  </response>
 
 
 To disable the log, change log level and configure other log output, use <b>Tray::Checkout</b> module:

data/lib/tray/checkout/base_transaction.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+module Tray
+  module Checkout
+    class BaseTransaction
+      def api_url
+        "#{Tray::Checkout.api_url}"
+      end
+
+      protected
+
+      def request(path, params)
+        xml = web_service.request!("#{api_url}#{path}", params)
+        parser.response(xml)
+      end
+
+      def web_service
+        @web_service ||= Tray::Checkout::WebService.new
+      end
+
+      def parser
+        @parser ||= Tray::Checkout::Parser.new
+      end
+    end
+  end
+end

data/lib/tray/checkout/config.rb

@@ -15,9 +15,17 @@ module Tray
 
       def api_url
         if environment == :production
-          "https://api.checkout.tray.com.br/api/transactions"
+          "https://api.traycheckout.com.br/"
         else
-          "http://api.sandbox.checkout.tray.com.br/api/v1/transactions"
+          "http://api.sandbox.traycheckout.com.br/"
+        end
+      end
+
+      def cart_url
+        if environment == :production
+          "http://checkout.tray.com.br/"
+        else
+          "http://checkout.sandbox.tray.com.br/"
         end
       end
 

data/lib/tray/checkout/response_parser.rb

@@ -30,7 +30,8 @@ module Tray
       end
 
       def create_response_hash
-        Hash.from_xml(@xml).symbolize_all_keys[:transaction]
+        hash = Hash.from_xml(@xml).symbolize_all_keys
+        hash[:response] || hash[:tmp_transaction]
       end
 
       def success?
@@ -57,7 +58,7 @@ module Tray
       end
 
       def create_data_response
-        data_response = response_hash[:data_response][:transaction]
+        data_response = response_hash[:data_response][:transaction] || response_hash[:data_response]
         transaction_map! data_response
         payment_map!     data_response
         customer_map!    data_response
@@ -66,29 +67,34 @@ module Tray
       end
 
       def transaction_map!(transaction)
-        transaction[:status] = TRANSACTION_STATUS.invert[transaction.delete(:status_id)]
-        transaction[:id] = transaction.delete(:transaction_id)
-        transaction[:token] = transaction.delete(:transaction_token)
-        transaction[:affiliates] = transaction.delete(:transaction_affiliates)
+        return {} unless transaction
+
+        transaction[:status] = TRANSACTION_STATUS.invert[transaction.delete(:status_id)] if transaction.has_key?(:status_id)
+        transaction[:id] = transaction.delete(:transaction_id) if transaction.has_key?(:transaction_id)
+        transaction[:token] = transaction.delete(:token_transaction) if transaction.has_key?(:token_transaction)
+        transaction[:products] = transaction.delete(:transaction_products) if transaction.has_key?(:transaction_products)
       end
 
       def payment_map!(transaction)
+        return {} if transaction.blank? || transaction[:payment].blank?
+
         payment = transaction[:payment]
-        payment[:method] = PAYMENT_METHOD.invert[payment.delete(:payment_method_id)]
-        payment[:method_name] = payment.delete(:payment_method_name)
-        payment[:price] = payment.delete(:price_payment)
-        payment[:response] = payment.delete(:payment_response)
-        payment[:url] = payment.delete(:url_payment)
+
+        payment[:method] = PAYMENT_METHOD.invert[payment.delete(:payment_method_id)] if payment.has_key?(:payment_method_id)
+        payment[:method_name] = payment.delete(:payment_method_name) if payment.has_key?(:payment_method_name)
+        payment[:price] = payment.delete(:price_payment) if payment.has_key?(:price_payment)
       end
 
       def customer_map!(transaction)
+        return {} if transaction.blank? || transaction[:customer].blank?
+
         customer = transaction[:customer]
 
         if customer[:contacts]
           customer[:contacts].each do |contact|
-            contact[:type] = CONTACT_TYPE.invert[contact.delete(:type_contact)]
-            contact[:id] = contact.delete(:contact_id)
-            contact[:number] = contact.delete(:value)
+            contact[:type] = CONTACT_TYPE.invert[contact.delete(:type_contact)] if contact.has_key?(:type_contact)
+            contact[:id] = contact.delete(:contact_id) if contact.has_key?(:contact_id)
+            contact[:number] = contact.delete(:value) if contact.has_key?(:value)
           end
         else
           customer[:contacts] = []
@@ -96,6 +102,8 @@ module Tray
       end
 
       def date_to_time!(hash)
+        return nil unless hash
+
         hash.each do |key, value|
           date_to_time!(value) if value.is_a?(Hash)
 

data/lib/tray/checkout/temp_transaction.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+module Tray
+  module Checkout
+    class TempTransaction < Tray::Checkout::BaseTransaction
+      def api_url
+        "#{Tray::Checkout.api_url}/v1/tmp_transactions/"
+      end
+
+      def initialize(token=nil)
+        @token = token || Tray::Checkout.token_account
+      end
+
+      def cart_url
+        "#{Tray::Checkout.cart_url}payment/car/v1/#{@token}" if @token
+      end
+
+      def add_to_cart(params)
+        request("create", parser.transaction_params(params))
+      end
+    end
+  end
+end

data/lib/tray/checkout/transaction.rb

@@ -1,28 +1,18 @@
 # encoding: UTF-8
 module Tray
   module Checkout
-    class Transaction
-      def get(token)
-        request("get_by_token", { token: token })
+    class Transaction < Tray::Checkout::BaseTransaction
+      def api_url
+        "#{Tray::Checkout.api_url}/v2/transactions/"
       end
 
-      def create(params)
-        request("pay_complete", parser.transaction_params(params))
-      end
-
-      private
-
-      def request(path, params)
-        xml = web_service.request!("#{Tray::Checkout.api_url}/#{path}", params)
-        parser.response(xml)
+      def get(token, account=nil)
+        account ||= Tray::Checkout.token_account
+        request("get_by_token", { token_account: account, token_transaction: token })
       end
 
-      def web_service
-        @web_service ||= Tray::Checkout::WebService.new
-      end
-
-      def parser
-        @parser ||= Tray::Checkout::Parser.new
+      def create(params)
+        request("pay_complete", parser.transaction_params(params))
       end
     end
   end

data/lib/tray/checkout/transaction_params_parser.rb

@@ -22,6 +22,7 @@ module Tray
 
       def customer_map!(customer)
         return unless customer
+        customer[:birth_date] = customer[:birth_date].strftime("%d/%m/%Y") if customer[:birth_date] && customer[:birth_date].is_a?(Date)
         customer[:gender] = SEX[customer[:sex]] if customer[:sex]
         customer[:relationship] = MARITAL_STATUS[customer[:marital_status]] if customer[:marital_status]
         contacts_map!  customer[:contacts]

data/lib/tray/checkout/version.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
 module Tray
   module Checkout
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end
 

data/lib/tray-checkout.rb

@@ -6,7 +6,9 @@ require 'tray/checkout/hash'
 require 'tray/checkout/parser'
 require 'tray/checkout/response'
 require 'tray/checkout/response_parser'
+require 'tray/checkout/base_transaction'
 require 'tray/checkout/transaction'
+require 'tray/checkout/temp_transaction'
 require 'tray/checkout/transaction_params_parser'
 require 'tray/checkout/uri'
 require 'tray/checkout/web_service'

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'tray-checkout'
 require 'webmock/rspec'
+require 'vcr'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
@@ -10,8 +11,6 @@ RSpec.configure do |config|
   config.order = "random"
 end
 
-WebMock.disable_net_connect!
-
 Tray::Checkout.configure do |config|
   config.log_enabled = false
 end

data/spec/support/mock_request.rb

@@ -13,7 +13,8 @@ def body_for(response)
        :get_failure_not_found,
        :create_success_boleto,
        :create_success_mastercard,
-       :create_failure_validation_errors
+       :create_failure_validation_errors,
+       :create_temp_transaction_with_token
     read_file_for(response)
   else
     response

data/spec/support/responses/create_failure_validation_errors.xml

@@ -1,52 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<transaction>
+<response>
+  <error_response>
+    <errors type="array">
+      <error>
+        <message>Tipo de Contato não está incluído na lista</message>
+        <code>13</code>
+      </error>
+    </errors>
+  </error_response>
   <message_response>
     <message>error</message>
   </message_response>
-  <error_response>
-    <validation_errors type="array">
-      <validation_error>
-        <code>1</code>
-        <message_complete>Tipo n&#227;o pode ficar em branco</message_complete>
-        <message>n&#227;o pode ficar em branco</message>
-        <field>person_addresses.type_address</field>
-      </validation_error>
-      <validation_error>
-        <code>1</code>
-        <message_complete>Logradouro (Rua, Av, Travessa...) n&#227;o pode ficar em branco</message_complete>
-        <message>n&#227;o pode ficar em branco</message>
-        <field>person_addresses.street</field>
-      </validation_error>
-      <validation_error>
-        <code>1</code>
-        <message_complete>Cep n&#227;o pode ficar em branco</message_complete>
-        <message>n&#227;o pode ficar em branco</message>
-        <field>person_addresses.postal_code</field>
-      </validation_error>
-      <validation_error>
-        <code>1</code>
-        <message_complete>Cidade n&#227;o pode ficar em branco</message_complete>
-        <message>n&#227;o pode ficar em branco</message>
-        <field>person_addresses.city</field>
-      </validation_error>
-      <validation_error>
-        <code>1</code>
-        <message_complete>UF n&#227;o pode ficar em branco</message_complete>
-        <message>n&#227;o pode ficar em branco</message>
-        <field>person_addresses.state</field>
-      </validation_error>
-      <validation_error>
-        <code>1</code>
-        <message_complete>N&#250;mero, Lote n&#227;o pode ficar em branco</message_complete>
-        <message>n&#227;o pode ficar em branco</message>
-        <field>person_addresses.number</field>
-      </validation_error>
-      <validation_error>
-        <code>1</code>
-        <message_complete>Bairro n&#227;o pode ficar em branco</message_complete>
-        <message>n&#227;o pode ficar em branco</message>
-        <field>person_addresses.neighborhood</field>
-      </validation_error>
-    </validation_errors>
-  </error_response>
-</transaction>
+</response>