braspag-api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b03f3a2de0a1b2d02c51ef95c6d5a5f6e65586c
+  data.tar.gz: 030c537f49715d1570200ff388f49b011a5189a6
+SHA512:
+  metadata.gz: 0df227b756d464774a85bd59051bf3dd36b2440f8647bf8046399ad01ce4074c42eb74891e393d21e3a0d0c5f9326850ee4407522615bde2674de13dae8b15f7
+  data.tar.gz: 8b0528ea93b944467c47ea096d608419e9eb9cd59e90adb5fa75216aa5fa59b8e4aa4fdb43f28c651329fbfedc99ff5aceb5dd4e87e0d6527f6ffb07f80a2ed9

data/lib/braspag/api.rb

@@ -0,0 +1,88 @@
+require "braspag/environment"
+require "braspag/merchant"
+
+require "braspag/api/address"
+require "braspag/api/credit_card"
+require "braspag/api/customer"
+require "braspag/api/payment"
+require "braspag/api/recurrent_payment"
+require "braspag/api/sale"
+
+require "braspag/api/request/create_sale_request"
+require "braspag/api/request/query_sale_request"
+require "braspag/api/request/update_sale_request"
+
+module Braspag
+    #  The Braspag API SDK front-end
+    class API
+        attr_accessor :merchant, :environment
+        private :merchant, :environment
+
+        # Create an instance of API by choosing the environment where the
+        # requests will be send
+        #
+        # @param merchant [Merchant] The merchant credentials
+        # @param environment [Environment] The environment
+        def initialize(
+            merchant,
+            environment = nil)
+
+            if (environment == nil)
+                environment = Environment.production()
+            end
+
+            @merchant = merchant
+            @environment = environment
+        end
+
+        # Send the Sale to be created and return the Sale with tid and the status
+        # returned by Braspag.
+        #
+        # @param sale [Sale] The preconfigured Sale
+        # @return [Sale] The Sale with authorization, tid, etc. returned by Braspag.
+        def create_sale(sale)
+            request = Braspag::Request::CreateSaleRequest.new(merchant, environment)
+
+            request.execute(sale)
+        end
+
+        # Query a Sale on Braspag by paymentId
+        #
+        # @param paymentId [String] The paymentId to be queried
+        # @return [Sale] The Sale with authorization, tid, etc. returned by Braspag.
+        def get_sale(payment_id)
+            request = Braspag::Request::QuerySaleRequest.new(merchant, environment)
+
+            request.execute(payment_id)
+        end
+
+        # Cancel a Payment on Braspag by paymentId and speficying the amount
+        #
+        # @param paymentId [String] The paymentId to be queried
+        # @param amount [Integer] Order value in cents
+        # @return [Payment] The cancelled payment
+        def cancel_payment(payment_id, amount=nil)
+            request = Braspag::Request::UpdateSaleRequest.new("void", merchant, environment)
+
+            request.amount = amount
+
+            request.execute(payment_id)
+        end
+
+        # Capture a Sale on Braspag by paymentId and specifying the amount and the
+        # serviceTaxAmount
+        #
+        # @param paymentId [String] The paymentId to be captured
+        # @param amount [Integer] Amount of the authorization to be captured
+        # @param serviceTaxAmount [Integer] Amount of the authorization should be destined for the service charge
+        # @return [Payment] The captured payment
+        def capture_sale(payment_id, amount=nil, service_tax_amount=nil)
+            request = Braspag::Request::UpdateSaleRequest.new("capture", merchant, environment)
+
+            request.amount = amount
+            request.service_tax_amount = service_tax_amount
+
+            request.execute(payment_id)
+        end
+    end
+end

data/lib/braspag/api/address.rb

@@ -0,0 +1,53 @@
+module Braspag
+    # Customer's address.
+    #
+    # @attr [String] street the customer's address
+    # @attr [String] number the customer's address number
+    # @attr [String] complement any complement of customer's address
+    # @attr [String] zip_code the zip code of customer's address
+    # @attr [String] city the city of customer's address
+    # @attr [String] state the state of customer's address
+    # @attr [String] country the country of customer's address
+    class Address
+        attr_accessor :street,
+                      :number,
+                      :complement,
+                      :zip_code,
+                      :city,
+                      :state,
+                      :country
+
+        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)
+                address = Address.new
+
+                address.street = data["Street"] || nil
+                address.number = data["Number"] || nil
+                address.complement = data["Complement"] || nil
+                address.zip_code = data["ZipCode"] || nil
+                address.city = data["City"] || nil
+                address.state = data["State"] || nil
+                address.country = data["Country"] || nil
+            end
+        end
+
+        private
+        def as_json(options={})
+            {
+                Street: @street,
+                Number: @number,
+                Complement: @complement,
+                ZipCode: @zip_code,
+                City: @city,
+                State: @state,
+                Country: @country
+            }
+        end
+    end
+end

data/lib/braspag/api/credit_card.rb

@@ -0,0 +1,60 @@
+module Braspag
+    # Credit card data
+    #
+    # @attr [String] card_number Credit card number
+    # @attr [String] holder Holder name
+    # @attr [String] expiration_date Credit card expiration date
+    # @attr [String] security_code Credit card security code
+    # @attr [Boolean] save_card Whether or not to save the card
+    # @attr [String] brand Credit card brand
+    # @attr [String] card_token Card token
+    class CreditCard
+        attr_accessor :card_number,
+                      :holder,
+                      :expiration_date,
+                      :security_code,
+                      :save_card,
+                      :brand,
+                      :card_token
+
+        def initialize(args = {})
+            @security_code = args[:security_code]
+            @brand = args[:brand]
+            @token = args[:token]
+        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)
+                credit_card = CreditCard.new()
+                credit_card.card_number = data["CardNumber"] || nil
+                credit_card.holder = data["Holder"] || nil
+                credit_card.expiration_date = data["ExpirationDate"] || nil
+                credit_card.security_code = data["SecurityCode"] || nil
+                credit_card.save_card = data["SaveCard"] || nil
+                credit_card.brand = data["Brand"] || nil
+                credit_card.card_token = data["CardToken"] || nil
+
+                return credit_card
+            end
+        end
+
+        private
+        def as_json(options={})
+            {
+                CardNumber: @card_number,
+                Holder: @holder,
+                ExpirationDate: @expiration_date,
+                SecurityCode: @security_code,
+                SaveCard: @save_card,
+                Brand: @brand,
+                CardToken: @card_token
+          }
+        end
+    end
+end

data/lib/braspag/api/customer.rb

@@ -0,0 +1,58 @@
+module Braspag
+    # Customer data
+    #
+    # @attr [String] name Customer name
+    # @attr [String] email Customer email
+    # @attr [String] birthDate Customer's birth date
+    # @attr [String] identity Customer id
+    # @attr [String] identityType The type of customer id
+    # @attr [Address] address Customer's address
+    # @attr [Address] deliveryAddress The delivery address
+    class Customer
+        attr_accessor :name,
+                      :email,
+                      :birth_date,
+                      :identity,
+                      :identity_type,
+                      :address,
+                      :delivery_adress
+
+        def initialize(name)
+            @name = name
+        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)
+                customer = Customer.new(data["Name"] || nil)
+
+                customer.email = data["Email"] || nil
+                customer.birth_date = data["BirthDate"] || nil
+                customer.identity = data["Identity"] || nil
+                customer.identity_type = data["IdentityType"] || nil
+                customer.address = Address.from_json(data["Address"] || nil)
+                customer.delivery_adress = Address.from_json(data["DeliveryAddress"] || nil)
+
+                return customer
+            end
+        end
+
+        private
+        def as_json(options={})
+            {
+                Name: @name,
+                Email: @email,
+                BirthDate: @birth_date,
+                Identity: @identity,
+                IdentityType: @identity_type,
+                Address: @address,
+                DeliveryAddress: @delivery_address
+          }
+        end
+    end
+end

data/lib/braspag/api/payment.rb

@@ -0,0 +1,127 @@
+module Braspag
+    class Payment
+        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,
+                      :type,
+                      :amount,
+                      :received_date,
+                      :captured_amount,
+                      :captured_date,
+                      :currency,
+                      :country,
+                      :reason_code,
+                      :reason_message,
+                      :provider_return_code,
+                      :provider_return_message,
+                      :status,
+                      :links,
+                      :extra_data_collection,
+                      :expiration_date,
+                      :url,
+                      :number,
+                      :bar_code_number,
+                      :digitable_line,
+                      :address
+
+        def initialize(amount, installments: 1)
+            @amount = amount
+            @installments = installments
+        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)
+                payment = Payment.new(data["Amount"] || nil)
+
+                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 = Braspag::RecurrentPayment.from_json(data["RecurrentPayment"] || nil)
+                payment.credit_card = Braspag::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.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.reason_code = data["ReasonCode"] || nil
+                payment.reason_message = data["ReasonMessage"] || nil
+                payment.provider_return_code = data["ProviderReturnCode"] || nil
+                payment.provider_return_message = data["ProviderReturnMessage"] || nil
+                payment.status = data["Status"] || nil
+
+                payment.links = data["Links"] || nil
+                payment.extra_data_collection = data["ExtraDataCollection"] || nil
+
+                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
+
+                return payment
+            end
+        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
+    end
+end

data/lib/braspag/api/recurrent_payment.rb

@@ -0,0 +1,46 @@
+module Braspag
+    class RecurrentPayment
+        INTERVAL_MONTHLY = "Monthly"
+        INTERVAL_BIMONTHLY = "Bimonthly"
+        INTERVAL_QUARTERLY = "Quarterly"
+        INTERVAL_SEMIANNUAL = "SemiAnnual"
+        INTERVAL_ANNUAL = "Annual"
+
+        attr_accessor :authorize_now,
+                      :start_date,
+                      :end_date,
+                      :interval
+
+        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 self.from_json(data)
+            if (data != nil)
+                recurrent_payment = RecurrentPayment.new(data["AuthorizeNow"] || false)
+
+                recurrent_payment.start_date =data["StartDate"] || nil
+                recurrent_payment.end_date =data["EndDate"] || nil
+                recurrent_payment.interval =data["Interval"] || nil
+
+                return recurrent_payment
+            end
+        end
+
+        private
+        def as_json(options={})
+            {
+                AuthorizeNow: @authorize_now,
+                StartDate: @start_date,
+                EndDate: @end_date,
+                Interval: @interval
+          }
+        end
+    end
+end

data/lib/braspag/api/request/braspag_error.rb

@@ -0,0 +1,7 @@
+module Braspag::Request
+    class BraspagError < StandardError
+        def initialize(msg=nil)
+            super
+        end
+    end
+end

data/lib/braspag/api/request/braspag_request.rb

@@ -0,0 +1,42 @@
+require "uuidtools"
+require "json"
+require "net/http"
+
+require "braspag/api/request/braspag_error"
+
+module Braspag::Request
+    class BraspagRequest
+        attr_accessor :merchant
+        private :merchant
+
+        def initialize(merchant)
+            @merchant = merchant
+        end
+
+        protected
+        def send_request(method, uri, data=nil)
+            body = nil
+            headers = {"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
+
+            client = Net::HTTP.new(uri.host, uri.port)
+            client.use_ssl = true
+
+            response = client.send_request(method, uri.path, body, headers)
+
+            data = JSON.parse(response.body)
+
+            raise BraspagError, "Error [" + data[0]["Code"].to_s + "] " + data[0]["Message"] if response.code.to_i >= 400
+
+            return data
+        end
+    end
+end

data/lib/braspag/api/request/create_sale_request.rb

@@ -0,0 +1,20 @@
+require "braspag/api/request/braspag_request"
+
+module Braspag::Request
+    class CreateSaleRequest < BraspagRequest
+        attr_accessor :environment
+        private :environment
+
+        def initialize(merchant, environment)
+            super(merchant)
+
+            @environment = environment
+        end
+
+        def execute(sale)
+            uri = URI.parse(@environment.api + "v2/sales")
+
+            Braspag::Sale.from_json(send_request("POST", uri, sale))
+        end
+    end
+end

data/lib/braspag/api/request/query_sale_request.rb

@@ -0,0 +1,20 @@
+require "braspag/api/request/braspag_request"
+
+module Braspag::Request
+    class QuerySaleRequest < BraspagRequest
+        attr_accessor :environment
+        private :environment
+
+        def initialize(merchant, environment)
+            super(merchant)
+
+            @environment = environment
+        end
+
+        def execute(payment_id)
+            uri = URI.parse(@environment.api_query + "v2/sales/" + payment_id)
+
+            Braspag::Sale.from_json(send_request("GET", uri))
+        end
+    end
+end

data/lib/braspag/api/request/update_sale_request.rb

@@ -0,0 +1,36 @@
+require "braspag/api/request/braspag_request"
+
+module Braspag::Request
+    class UpdateSaleRequest < BraspagRequest
+        attr_accessor :environment,
+                      :type,
+                      :service_tax_amount,
+                      :amount
+
+        private :environment, :type
+
+        def initialize(type, merchant, environment)
+            super(merchant)
+
+            @environment = environment
+            @type = type
+        end
+
+        def execute(payment_id)
+            uri = URI.parse(@environment.api + "v2/sales/" + payment_id + "/" + type)
+            params = {}
+
+            if (amount != nil)
+                params["amount"] = amount
+            end
+
+            if (service_tax_amount != nil)
+                params["serviceTaxAmount"] = service_tax_amount
+            end
+
+            uri.query = URI.encode_www_form(params)
+
+            Braspag::Payment.from_json(send_request("PUT", uri))
+        end
+    end
+end

data/lib/braspag/api/sale.rb

@@ -0,0 +1,37 @@
+module Braspag
+    class Sale
+        attr_accessor :merchant_order_id,
+                      :customer,
+                      :payment
+
+        def initialize(merchant_order_id)
+            @merchant_order_id = merchant_order_id
+        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)
+                sale = Sale.new(data["MerchantOrderId"] || nil)
+
+                sale.customer = Customer.from_json(data["Customer"] || nil)
+                sale.payment = Payment.from_json(data["Payment"] || nil)
+
+                return sale
+            end
+        end
+
+        private
+        def as_json(options={})
+            {
+                MerchantOrderId: @merchant_order_id,
+                Customer: @customer,
+                Payment: @payment
+            }
+        end
+    end
+end

data/lib/braspag/api/version.rb

@@ -0,0 +1,6 @@
+module Braspag
+    class API
+        # Versão da gem
+        VERSION = "1.0.0"
+    end
+end

data/lib/braspag/environment.rb

@@ -0,0 +1,31 @@
+module Braspag
+    # 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()
+            return Environment.new("https://api.braspag.com.br/",
+                                   "https://apiquery.braspag.com.br/")
+        end
+
+        # The sandbox environment
+        #
+        # @return [Environment] a configured Environment for testing
+        def self.sandbox()
+            return Environment.new("https://apisandbox.braspag.com.br/",
+                                   "https://apiquerysandbox.braspag.com.br/")
+        end
+    end
+end

data/lib/braspag/merchant.rb

@@ -0,0 +1,17 @@
+module Braspag
+    # Merchant identification on Braspag
+    #
+    # @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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: braspag-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Braspag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: Integração com a API da Braspag
+email:
+- desenvolvedores@braspag.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/braspag/api.rb
+- lib/braspag/api/address.rb
+- lib/braspag/api/credit_card.rb
+- lib/braspag/api/customer.rb
+- lib/braspag/api/payment.rb
+- lib/braspag/api/recurrent_payment.rb
+- lib/braspag/api/request/braspag_error.rb
+- lib/braspag/api/request/braspag_request.rb
+- lib/braspag/api/request/create_sale_request.rb
+- lib/braspag/api/request/query_sale_request.rb
+- lib/braspag/api/request/update_sale_request.rb
+- lib/braspag/api/sale.rb
+- lib/braspag/api/version.rb
+- lib/braspag/environment.rb
+- lib/braspag/merchant.rb
+homepage: https://github.com/braspag/BraspagApiiRubySdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: SDK API Braspag
+test_files: []