cielo-api30 1.0.0 → 1.1.0

data/lib/cielo/api30/environment.rb

@@ -0,0 +1,31 @@
+module Cielo
+  module API30
+    # API Environment URLs
+    #
+    # @attr [String] api API URL
+    # @attr [String] apiQuery API Query URL
+    class Environment
+      attr_accessor :api,
+                    :api_query
+
+      def initialize(api, api_query)
+        @api = api
+        @api_query = api_query
+      end
+
+      # The production environment
+      #
+      # @return [Environment] a configured Environment for production
+      def self.production
+        new("https://api.cieloecommerce.cielo.com.br/", "https://apiquery.cieloecommerce.cielo.com.br/")
+      end
+
+      # The sandbox environment
+      #
+      # @return [Environment] a configured Environment for testing
+      def self.sandbox
+        new("https://apisandbox.cieloecommerce.cielo.com.br/", "https://apiquerysandbox.cieloecommerce.cielo.com.br/")
+      end
+    end
+  end
+end

data/lib/cielo/api30/merchant.rb

@@ -0,0 +1,19 @@
+module Cielo
+  module API30
+    # Merchant identification on Cielo
+    #
+    # @attr [String] merchant_id the merchant identification number
+    # @attr [String] merchant_key the merchant identification key
+    class Merchant
+      attr_accessor :merchant_id,
+                    :merchant_key
+
+      # @param merchant_id [String] the merchant identification number
+      # @param merchant_key [String] the merchant identification key
+      def initialize(merchant_id, merchant_key)
+        @merchant_id = merchant_id
+        @merchant_key = merchant_key
+      end
+    end
+  end
+end

data/lib/cielo/api30/payment.rb

@@ -1,125 +1,136 @@
+require "cielo/api30/payment/status"
+require "cielo/api30/return_info"
+
 module Cielo
+  module API30
     class Payment
-        PAYMENTTYPE_CREDITCARD = "CreditCard"
-        PAYMENTTYPE_DEBITCARD = "DebitCard"
-        PAYMENTTYPE_ELECTRONIC_TRANSFER = "ElectronicTransfer"
-        PAYMENTTYPE_BOLETO = "Boleto"
+      PAYMENTTYPE_CREDITCARD = "CreditCard"
+      PAYMENTTYPE_DEBITCARD = "DebitCard"
+      PAYMENTTYPE_ELECTRONIC_TRANSFER = "ElectronicTransfer"
+      PAYMENTTYPE_BOLETO = "Boleto"
+
+      PROVIDER_BRADESCO = "Bradesco"
+      PROVIDER_BANCO_DO_BRASIL = "BancoDoBrasil"
+      PROVIDER_SIMULADO = "Simulado"
+
+      attr_accessor :service_tax_amount,
+                    :installments,
+                    :interest,
+                    :capture,
+                    :authenticate,
+                    :recurrent,
+                    :recurrent_payment,
+                    :credit_card,
+                    :proof_of_sale,
+                    :authorization_code,
+                    :soft_descriptor,
+                    :return_url,
+                    :provider,
+                    :payment_id,
+                    :tid,
+                    :type,
+                    :amount,
+                    :received_date,
+                    :captured_amount,
+                    :captured_date,
+                    :currency,
+                    :country,
+                    :return_code,
+                    :return_message,
+                    :status,
+                    :links,
+                    :extra_data_collection,
+                    :expiration_date,
+                    :url,
+                    :number,
+                    :bar_code_number,
+                    :digitable_line,
+                    :address,
+                    :return_info
 
-        PROVIDER_BRADESCO = "Bradesco"
-        PROVIDER_BANCO_DO_BRASIL = "BancoDoBrasil"
-        PROVIDER_SIMULADO = "Simulado"
+      def initialize(amount, installments: 1)
+        @amount = amount
+        @installments = installments
+      end
 
-        attr_accessor :service_tax_amount,
-                      :installments,
-                      :interest,
-                      :capture,
-                      :authenticate,
-                      :recurrent,
-                      :recurrent_payment,
-                      :credit_card,
-                      :proof_of_sale,
-                      :authorization_code,
-                      :soft_descriptor,
-                      :return_url,
-                      :provider,
-                      :payment_id,
-                      :tid,
-                      :type,
-                      :amount,
-                      :received_date,
-                      :captured_amount,
-                      :captured_date,
-                      :currency,
-                      :country,
-                      :return_code,
-                      :return_message,
-                      :status,
-                      :links,
-                      :extra_data_collection,
-                      :expiration_date,
-                      :url,
-                      :number,
-                      :bar_code_number,
-                      :digitable_line,
-                      :address
+      def to_json(*options)
+        hash = as_json(*options)
+        hash.reject! {|k,v| v.nil?}
+        hash.to_json(*options)
+      end
 
-        def initialize(amount, installments: 1)
-            @amount = amount
-            @installments = installments
-        end
+      def self.from_json(data)
+        return if data.nil?
 
-        def to_json(*options)
-            hash = as_json(*options)
-            hash.reject! {|k,v| v.nil?}
-            hash.to_json(*options)
-        end
+        payment = new(data["Amount"])
 
-        def self.from_json(data)
-            if (data != nil)
-                payment = Payment.new(data["Amount"] || nil)
+        payment.service_tax_amount = data["ServiceTaxAmount"]
+        payment.installments = data["Installments"]
+        payment.interest = data["Interest"]
+        payment.capture = data["Capture"]
+        payment.authenticate = data["Authenticate"]
+        payment.recurrent = data["Recurrent"]
+        payment.recurrent_payment = RecurrentPayment.from_json(data["RecurrentPayment"])
+        payment.credit_card = CreditCard.from_json(data["CreditCard"])
+        payment.proof_of_sale = data["ProofOfSale"]
+        payment.authorization_code = data["AuthorizationCode"]
+        payment.soft_descriptor = data["SoftDescriptor"]
+        payment.return_url = data["ReturnUrl"]
+        payment.provider = data["Provider"]
+        payment.payment_id = data["PaymentId"]
+        payment.tid = data["Tid"]
+        payment.type = data["Type"]
+        payment.received_date = data["ReceivedDate"]
+        payment.captured_amount = data["CapturedAmount"]
+        payment.captured_date = data["CapturedDate"]
+        payment.currency = data["Currency"]
+        payment.country = data["Country"]
+        payment.return_code = data["ReturnCode"]
+        payment.return_message = data["ReturnMessage"]
+        payment.status = data["Status"]
 
-                payment.service_tax_amount = data["ServiceTaxAmount"] || nil
-                payment.installments = data["Installments"] || nil
-                payment.interest = data["Interest"] || nil
-                payment.capture = data["Capture"] || nil
-                payment.authenticate = data["Authenticate"] || nil
-                payment.recurrent = data["Recurrent"] || nil
-                payment.recurrent_payment = Cielo::RecurrentPayment.from_json(data["RecurrentPayment"] || nil)
-                payment.credit_card = Cielo::CreditCard.from_json(data["CreditCard"] || nil)
-                payment.proof_of_sale = data["ProofOfSale"] || nil
-                payment.authorization_code = data["AuthorizationCode"] || nil
-                payment.soft_descriptor = data["SoftDescriptor"] || nil
-                payment.return_url = data["ReturnUrl"] || nil
-                payment.provider = data["Provider"] || nil
-                payment.payment_id = data["PaymentId"] || nil
-                payment.tid = data["Tid"] || nil
-                payment.type = data["Type"] || nil
-                payment.received_date = data["ReceivedDate"] || nil
-                payment.captured_amount = data["CapturedAmount"] || nil
-                payment.captured_date = data["CapturedDate"] || nil
-                payment.currency = data["Currency"] || nil
-                payment.country = data["Country"] || nil
-                payment.return_code = data["ReturnCode"] || nil
-                payment.return_message = data["ReturnMessage"] || nil
-                payment.status = data["Status"] || nil
+        payment.links = data["Links"]
+        payment.extra_data_collection = data["ExtraDataCollection"]
 
-                payment.links = data["Links"] || nil
-                payment.extra_data_collection = data["ExtraDataCollection"] || nil
+        payment.expiration_date = data["ExpirationDate"]
+        payment.url = data["Url"]
+        payment.number = data["Number"]
+        payment.bar_code_number = data["BarCodeNumber"]
+        payment.digitable_line = data["DigitableLine"]
+        payment.address = data["Address"]
+        payment.return_info = ReturnInfo.new(payment.return_code)
 
-                payment.expiration_date = data["ExpirationDate"] || nil
-                payment.url = data["Url"] || nil
-                payment.number = data["Number"] || nil
-                payment.bar_code_number = data["BarCodeNumber"] || nil
-                payment.digitable_line = data["DigitableLine"] || nil
-                payment.address = data["Address"] || nil
+        payment
+      end
 
-                return payment
-            end
-        end
+      def success?
+        Status.success?(status)
+      end
 
-        private
-        def as_json(options={})
-            {
-                ServiceTaxAmount: @service_tax_amount,
-                Installments: @installments,
-                Interest: @interest,
-                Capture: @capture,
-                Authenticate: @authenticate,
-                Recurrent: @recurrent,
-                RecurrentPayment: @recurrent_payment,
-                CreditCard: @credit_card,
-                SoftDescriptor: @soft_descriptor,
-                ReturnUrl: @return_url,
-                Provider: @provider,
-                Type: @type,
-                Amount: @amount,
-                Currency: @currency,
-                Country: @country,
-                Number: @number,
-                BarCodeNumber: @bar_code_number,
-                DigitableLine: @digitable_line,
-                Address: @address
-          }
-        end
+      def as_json(options={})
+        {
+          ServiceTaxAmount: @service_tax_amount,
+          Installments: @installments,
+          Interest: @interest,
+          Capture: @capture,
+          Authenticate: @authenticate,
+          Recurrent: @recurrent,
+          RecurrentPayment: @recurrent_payment,
+          CreditCard: @credit_card,
+          SoftDescriptor: @soft_descriptor,
+          ReturnUrl: @return_url,
+          Provider: @provider,
+          Type: @type,
+          Amount: @amount,
+          Currency: @currency,
+          Country: @country,
+          Number: @number,
+          BarCodeNumber: @bar_code_number,
+          DigitableLine: @digitable_line,
+          Address: @address,
+          ReturnInfo: @return_info
+        }
+      end
     end
+  end
 end

data/lib/cielo/api30/payment/status.rb

@@ -0,0 +1,28 @@
+module Cielo
+  module API30
+    class Payment
+      module Status
+        NOT_FINISHED      = 0
+        AUTHORIZED        = 1
+        PAYMENT_CONFIRMED = 2
+        DENIED            = 3
+        VOIDED            = 10
+        REFUNDED          = 11
+        PENDING           = 12
+        ABORTED           = 13
+        SCHEDULED         = 20
+
+        def self.success?(code)
+          [
+            AUTHORIZED,
+            PAYMENT_CONFIRMED,
+            VOIDED,
+            REFUNDED,
+            PENDING,
+            SCHEDULED
+          ].include?(code)
+        end
+      end
+    end
+  end
+end

data/lib/cielo/api30/recurrent_payment.rb

@@ -1,46 +1,45 @@
 module Cielo
+  module API30
     class RecurrentPayment
-        INTERVAL_MONTHLY = "Monthly"
-        INTERVAL_BIMONTHLY = "Bimonthly"
-        INTERVAL_QUARTERLY = "Quarterly"
-        INTERVAL_SEMIANNUAL = "SemiAnnual"
-        INTERVAL_ANNUAL = "Annual"
+      INTERVAL_MONTHLY = "Monthly"
+      INTERVAL_BIMONTHLY = "Bimonthly"
+      INTERVAL_QUARTERLY = "Quarterly"
+      INTERVAL_SEMIANNUAL = "SemiAnnual"
+      INTERVAL_ANNUAL = "Annual"
 
-        attr_accessor :authorize_now,
-                      :start_date,
-                      :end_date,
-                      :interval
+      attr_accessor :authorize_now,
+                    :start_date,
+                    :end_date,
+                    :interval
 
-        def initialize(authorize_now=true)
-            @authorize_now = authorize_now
-        end
+      def initialize(authorize_now=true)
+        @authorize_now = authorize_now
+      end
 
-        def to_json(*options)
-            hash = as_json(*options)
-            hash.reject! {|k,v| v.nil?}
-            hash.to_json(*options)
-        end
+      def to_json(*options)
+        hash = as_json(*options)
+        hash.reject! {|k,v| v.nil?}
+        hash.to_json(*options)
+      end
 
-        def self.from_json(data)
-            if (data != nil)
-                recurrent_payment = RecurrentPayment.new(data["AuthorizeNow"] || false)
+      def self.from_json(data)
+        return if data.nil?
 
-                recurrent_payment.start_date =data["StartDate"] || nil
-                recurrent_payment.end_date =data["EndDate"] || nil
-                recurrent_payment.interval =data["Interval"] || nil
+        recurrent_payment = new(data["AuthorizeNow"])
+        recurrent_payment.start_date =data["StartDate"]
+        recurrent_payment.end_date =data["EndDate"]
+        recurrent_payment.interval =data["Interval"]
+        recurrent_payment
+      end
 
-                return recurrent_payment
-            end
-        end
-
-        private
-        def as_json(options={})
-            {
-                AuthorizeNow: @authorize_now,
-                StartDate: @start_date,
-                EndDate: @end_date,
-                Interval: @interval
-          }
-        end
+      def as_json(options={})
+        {
+          AuthorizeNow: @authorize_now,
+          StartDate: @start_date,
+          EndDate: @end_date,
+          Interval: @interval
+        }
+      end
     end
+  end
 end

data/lib/cielo/api30/request/cielo_error.rb

@@ -1,7 +1,15 @@
-module Cielo::Request
-    class CieloError < StandardError
-        def initialize(msg=nil)
-            super
+module Cielo
+  module API30
+    module Request
+      class CieloError < StandardError
+        attr_reader :code, :body
+
+        def initialize(code, body)
+          @code = code
+          @body = body
+          super("Error [#{code}] #{body}")
         end
+      end
     end
+  end
 end

data/lib/cielo/api30/request/cielo_request.rb

@@ -4,40 +4,44 @@ require "net/http"
 
 require "cielo/api30/request/cielo_error"
 
-module Cielo::Request
-    class CieloRequest
+module Cielo
+  module API30
+    module Request
+      class CieloRequest
         attr_accessor :merchant
         private :merchant
 
         def initialize(merchant)
-            @merchant = merchant
+          @merchant = merchant
         end
 
         protected
         def send_request(method, uri, data=nil)
-            body = nil
-            headers = {"User-Agent" => "CieloEcommerce/3.0 Ruby SDK",
-                       "RequestId" => UUIDTools::UUID.random_create.to_s,
-                       "MerchantId" => merchant.merchant_id,
-                       "MerchantKey" => merchant.merchant_key}
+          body = nil
+          headers = {"User-Agent" => "CieloEcommerce/3.0 Ruby SDK",
+                     "RequestId" => UUIDTools::UUID.random_create.to_s,
+                     "MerchantId" => merchant.merchant_id,
+                     "MerchantKey" => merchant.merchant_key}
 
-            if (data == nil)
-                headers["Content-Length"] = "0"
-            else
-                headers["Content-Type"] = "application/json"
-                body = data.to_json
-            end
+          if data.nil?
+            headers["Content-Length"] = "0"
+          else
+            headers["Content-Type"] = "application/json"
+            body = data.to_json
+          end
 
-            client = Net::HTTP.new(uri.host, uri.port)
-            client.use_ssl = true
+          client = Net::HTTP.new(uri.host, uri.port)
+          client.use_ssl = true
 
-            response = client.send_request(method, uri.path, body, headers)
+          response = client.send_request(method, uri.path, body, headers)
 
-            data = JSON.parse(response.body)
+          data = JSON.parse(response.body)
 
-            raise CieloError, "Error [" + data[0]["Code"].to_s + "] " + data[0]["Message"] if response.code.to_i >= 400
+          raise CieloError.new(data.first["Code"], data.first["Message"]) if response.code.to_i >= 400
 
-            return data
+          data
         end
+      end
     end
+  end
 end