midas_client 0.1.1

data/lib/midas_client/subscription.rb

@@ -0,0 +1,265 @@
+module MidasClient
+
+  class Subscription < MidasClient::Request
+    include EndPoints
+
+    # This method creates a subscription.
+    # It is a synchronous operation, using method POST
+    #
+    # Params:
+    #   externalId: string (Transaction identification on the client application)
+    #   externalDate: [optional] datetime from client application - YYYY-MM-DDThh:mm:SS.sssTDZ - ISO8601
+    #   frequencyType string Is the frequency about the charge will run. Possible values: DAY/WEEK/MONTH
+    #   frequencyInterval integer The interval that will be used.
+    #   startDate datetime for the beginning of subscription - yyyy-MM-dd
+    #   invoicesCount integer - number of invoices for the subscription
+    #   amount: number (Only integer numbers, with the last two digits representing the cents.
+    #                   For example: 100 is equivalent to R$ 1,00)
+    #   cardToken: string (created by method card_store)
+    #   cvv: number (Security Code)
+    #   callbackUrl string - URL to receive the result for each invoice charge
+    #
+    # Response:
+    # {
+    #    "result": {
+    #        "success": "true",
+    #        "code": "0",
+    #        "message": "Sucesso"
+    #    },
+    #    "subscriptionToken": "49ac54257eb1f92f"
+    # }
+    #
+    #
+    # Response with first payment
+    # {
+    #    "result": {
+    #        "success": "true",
+    #        "code": "0",
+    #        "message": "Sucesso"
+    #    },
+    #    "subscriptionToken": "49ac54257eb1f92f",
+    #    "firstInvoiceResult": {
+    #        "success": true,
+    #        "code": "000",
+    #        "message": "Sucesso"
+    #    }
+    # }
+    #
+    #
+    # Error response
+    #{
+    # "result": {
+    #      "success": "false",
+    #      "code": "114",
+    #      "message": "O token do cartao é obrigatório"
+    #  }
+    #}
+    #
+    def self.create_subscription(*params)
+      # Parametros são recebidos como um array de hash, pego o 1o item do array
+      params = params.first
+
+      # inicializa as variáveis de retorno
+      result ={}
+
+      first_invoice_result = ""
+      subscription_token = ""
+
+      # define o método de envio da requisição
+      method = :post
+
+      # monta a URL de chamada da requisição
+      endpoint=  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Subscriptions[:create]
+
+
+      params[:externalDate] = (params[:externaldate].blank? ? Time.now.iso8601(1) : params[:externaldate])
+      params[:invoicesCount]= (params[:invoicesCount].blank? ? 12 : params[:invoicesCount])
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      response = request(method, endpoint, self.login, self.password, params)
+
+      result = response[:result]
+      subscription_token = response[:subscriptionToken] if !response[:subscriptionToken].nil?
+      first_invoice_result = response[:firstInvoiceResult]
+
+      # grava o tempo de execução da operação
+      total_time_execution = Time.now - start_time_execution
+
+      return result, subscription_token, first_invoice_result
+    end
+
+    # This method cancel a subscription.
+    # This is a is synchronous operation.
+    #
+    # Params:
+    #   subscriptionToken: string (Subscription unique identification generated by our
+    #                             gateway and received in the subscription's creation response)
+    #
+    # Response:
+    #   result: {
+    #     success: true/false
+    #     code: "XXX"
+    #     message: "Some message to you"
+    #   }
+    def self.cancel_subscription(subscription_token)
+      # inicializa as variáveis de retorno
+      result ={}
+
+      # define o método de envio da requisição
+      method = :put
+
+      # monta a URL de chamada da requisição
+      endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Subscriptions[:cancel].gsub("{subscriptionToken}", subscription_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      response = request(method, endpoint, self.login, self.password, {})
+
+      result = response[:result]
+
+      return result
+    end
+
+    # This method performs a query by a specific transaction.
+    # This is a is synchronous operation, using method GET
+    #
+    # Params:
+    #   subscription_token: string (Transaction unique identification generated by our
+    #                             gateway and received in the subscription's create response)#
+    #
+    #
+    # Response:
+    # {
+    #   :result=>{
+    #     :success=>true,
+    #     :code=>"000",
+    #     :message=>"Sucesso"
+    #   },
+    #   :subscription=>{
+    #     :externalId=>"10011",
+    #     :frequencyType=>"MONTH",
+    #     :frequencyInterval=>1,
+    #     :startDate=>"2016-07-28T00:00:00.000-04",
+    #     :invoicesCount=>12,
+    #     :paymentMethod=>"CREDIT_CARD",
+    #     :amount=>5000,
+    #     :creditCard=>{
+    #       :brand=>"VISA",
+    #       :panLastDigits=>"1855",
+    #       :expirationMonth=>12,
+    #       :expirationYear=>2020,
+    #       :holderName=>"TESTE CONSOLE",
+    #       :customer=>{
+    #         :documentType=>"CPF",
+    #         :documentNumber=>"41468031520"
+    #       }
+    #     },
+    #     :token=>"a2bebd13f0a43e5a",
+    #     :status=>"CANCELLED"
+    #   }
+    # }
+    def self.subscription_by_token(subscription_token)
+      # inicializa as variáveis de retorno
+      result ={}
+
+      # define o método de envio da requisição
+      method = :get
+
+      # monta a URL de chamada da requisição
+      endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Subscriptions[:by_token].gsub("{subscriptionToken}", subscription_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      response = request(method, endpoint, self.login, self.password, {})
+
+      result = response[:result]
+
+      return result, response[:subscription]
+    end
+
+
+    # This method performs a query by a specific transaction.
+    # This is a is synchronous operation, using method GET
+    #
+    # Params:
+    #   subscription_token: string (Transaction unique identification generated by our
+    #                             gateway and received in the subscription's create response)#
+    #
+    #
+    # Response:
+    #
+    # {
+    #   :result=>{
+    #     :success=>true,
+    #     :code=>"000",
+    #     :message=>"Sucesso"
+    #   },
+    #   :invoices=>[{
+    #     :number=>1,
+    #     :amount=>5000,
+    #     :expirationDate=>"2016-07-28",
+    #     :token=>"8bc3bf2ff9b08566fa8496fdce6c6f99",
+    #     :status=>"PAID"
+    #   }. {:number=>2,...}, {:number=>3,}]
+    # }
+    def self.subscription_invoices(subscription_token)
+      # inicializa as variáveis de retorno
+      result ={}
+
+      # define o método de envio da requisição
+      method = :get
+
+      # monta a URL de chamada da requisição
+      endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Subscriptions[:invoices].gsub("{subscriptionToken}", subscription_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      response = request(method, endpoint, self.login, self.password, {})
+
+      result = response[:result]
+
+      invoices = response[:invoices]
+
+      return result, invoices
+    end
+
+
+    # This method updates the credit card information associated to the subscription.
+    # This is a is synchronous operation, using method PUT
+    #
+    # Params:
+    #   subscription_token: string (Transaction unique identification generated by our
+    #                             gateway and received in the subscription's create response)#
+    #   new_card_token: string that represents the new credit card token (created using card_store) for the subscription
+    #
+    # Response:
+    # {
+    #  "result": {
+    #    "success": true,
+    #    "code": "0",
+    #    "message": "Sucesso"
+    #  }
+    # }
+    #
+    def self.update_subscription_card(subscription_token, new_card_token)
+      # inicializa as variáveis de retorno
+      result ={}
+
+      # define o método de envio da requisição
+      method = :put
+
+      # monta a URL de chamada da requisição
+      endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Subscriptions[:update_card].gsub("{subscriptionToken}", subscription_token)
+
+      params = {
+          cardToken: new_card_token
+      }
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      response = request(method, endpoint, self.login, self.password, params)
+
+      result = response[:result]
+
+      return result
+    end
+
+  end
+
+end

data/lib/midas_client/transaction.rb

@@ -0,0 +1,396 @@
+module MidasClient
+    class Transaction < MidasClient::Request
+
+      include MidasClient::EndPoints
+
+      # This method securely stores credit card's data (pan, expiration...)
+      # and returns a token to be used to perform payment transactions.
+      #
+      # Params:
+      #   externalId: number (Transaction identification on the client application)
+      #   pan: number
+      #   expirationMonth: number (format: MM)
+      #   expirationYear: number (format: YYYY)
+      #   holderName: string
+      #   customer/documentType: string (values: {'CPF', 'CNPJ'})
+      #   customer/documentNumber: string
+      #
+      # Response success:
+      #  {
+      #    "result": {
+      #      "success":"true",
+      #      "code":"000",
+      #      "message":"Success"
+      #    },
+      #    "brand":"VISA",
+      #    "cardToken":"2b5141a2209384e4266c8f7cbaf67a2d"
+      #  }
+      #
+      # Response Failure
+      # {
+      #   :result=>{
+      #     :success=>false,
+      #     :code=>"120",
+      #     :message=>"O numero do documento eh obrigatorio"
+      #   }
+      # }
+      #
+      def card_store(*params)
+        # Parametros são recebidos como um array de hash, pego o 1o item do array
+        params = params.first
+
+        # inicializa as variáveis de retorno
+        result ={}
+        card_token = nil
+
+        # define o método de envio da requisição
+        method = :post
+
+        # monta a URL de chamada da requisição
+        endpoint=  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:store]
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = request(method, endpoint, login, password, params)
+
+        result = response[:result]
+        card_token = response[:cardToken] if !response[:cardToken].nil?
+
+        return result, card_token
+      end
+
+      # This method creates a payment transaction, already performing
+      # the authorization and capture in only one step.
+      #
+      # Params:
+      #   externalId: string (Transaction identification on the client application)
+      #   externalDate: Date and time form client application - YYYY-MM-DDThh:mm:SS.sssTDZ - ISO8601
+      #   cardToken: string (created by method card_store)
+      #   cvv: number (Security Code)
+      #   amount: number (Only integer numbers, with the last two digits representing the cents.
+      #                   For example: 100 is equivalent to R$ 1,00)
+      #   instalments: number (1 to 12)
+      #
+      # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   },
+      #   transactionToken: "65ffe2897b832cb89cb2063b74fbb143",
+      #   nsu: "99999"
+      #
+      def synchronous_transaction(*params)
+        # Parametros são recebidos como um array de hash, pego o 1o item do array
+        params = params.first
+
+        # inicializa as variáveis de retorno
+        result ={}
+        nsu = ""
+        transaction_token = ""
+
+        # define o método de envio da requisição
+        method = :post
+
+        # monta a URL de chamada da requisição
+        endpoint=  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:synchronous_transaction]
+
+        # regulariza o formato da data
+        params[:externaldate] = params[:externaldate].blank? ? Time.now.iso8601(1) : params[:externaldate]
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = request(method, endpoint, self.login, self.password, params)
+
+        result = response[:result]
+        nsu = response[:nsu] if !response[:nsu].nil?
+        transaction_token = response[:transactionToken] if !response[:transactionToken].nil?
+
+        return result, transaction_token, nsu
+      end
+
+      # This method dispatches a payment transaction creation request, already performing
+      # the authorization and capture in only one step, but sending the response using the
+      # informed callback URL, in an asynchronous away.
+      #
+      # Params:
+      #   externalId: string (Transaction identification on the client application)
+      #   externalDate: Date and time form client application - YYYY-MM-DDThh:mm:SS.sssTDZ - ISO8601
+      #   cardToken: string (created by method card_store)
+      #   cvv: number (Security Code)
+      #   softDescriptor: string (Text to be shown on the credit card invoice entry)
+      #   amount: number (Only integer numbers, with the last two digits representing the cents.
+      #                   For example: 100 is equivalent to R$ 1,00)
+      #   instalments: number (1 to 12)
+      #   callbackUrl: string (URL used to notify the client application about the transaction creation result. )
+      #
+      # # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   },
+      #   transactionToken: "65ffe2897b832cb89cb2063b74fbb143",
+      #
+      def self.asynchronous_transaction(*params)
+        # Parametros são recebidos como um array de hash, pego o 1o item do array
+        params = params.first
+
+        # inicializa as variáveis de retorno
+        result ={}
+        transaction_token = ""
+
+        # define o método de envio da requisição
+        method = :post
+
+        # monta a URL de chamada da requisição
+        endpoint=  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:asynchronous_transaction]
+
+        # regulariza o formato da data
+        params[:externalDate] = (params[:externaldate].blank? ? Time.now.iso8601(1) : params[:externaldate])
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = request(method, endpoint, self.login, self.password, params)
+
+        result = response[:result]
+        transaction_token = response[:transactionToken] if !response[:transactionToken].nil?
+
+        return result, transaction_token
+      end
+
+      # This method dispatches a debit payment transaction request, that's receive an authorization URL,
+      # where the payer must authorize the transaction.
+      #
+      # Params:
+      #   externalId: string (Transaction identification on the client application)
+      #   externalDate: Date and time form client application - YYYY-MM-DDThh:mm:SS.sssTDZ - ISO8601
+      #   pan: DebitCard Number
+      #   expirationMonth:
+      #   expirationYear:
+      #   holderName:
+      #   customer/documentType: CPF/CNPJ
+      #   customer/documentNumber: if CPF 11 digits else CNPJ 13 digits
+      #   cvv: number (Security Code)
+      #   amount: number (Only integer numbers, with the last two digits representing the cents.
+      #                   For example: 100 is equivalent to R$ 1,00)
+      #   callbackUrl: string (URL used to notify the client application about the transaction authorization result. async notification )
+      #   redirectUrl: string (URL used to notify the client application that the transaction authorization result successful. )
+      #   errorUrl: string (URL used to notify the client application that the transaction authorization result failed)
+      #
+      # # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   },
+      #   "authenticationUrl": "https://qasecommerce.cielo.com.br/web/index.cbmp?id=ac470d041f660e21d253a5741e59c5b4",
+      #   "transactionToken":"6accbedb2da4f7bfbca5b5fed3669be6",
+      #
+      def self.asynchronous_debit_transaction(*params)
+        # Parametros são recebidos como um array de hash, pego o 1o item do array
+        params = params.first
+
+        # inicializa as variáveis de retorno
+        result ={}
+        transaction_token = ""
+
+        # define o método de envio da requisição
+        method = :post
+
+        # monta a URL de chamada da requisição
+        endpoint=  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:asynchronous_debit_transaction]
+
+        # regulariza formato da data
+        params[:externalDate] = (params[:externaldate].blank? ? Time.now.iso8601(1) : params[:externaldate])
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = request(method, endpoint, self.login, self.password, params)
+
+        result = response[:result]
+        authentication_url = response[:authenticationUrl] unless response[:authenticationUrl].nil?
+        transaction_token = response[:transactionToken] unless response[:transactionToken].nil?
+
+        return result, authentication_url, transaction_token
+      end
+
+      # This method performs a payment authorization. This is a is synchronous operation.
+      # To confirm the payment and finish the transaction you must send a capture request
+      #
+      # Params:
+      #   externalId: string (Transaction identification on the client application)
+      #   externalDate: Date and time form client application - YYYY-MM-DDThh:mm:SS.sssTDZ - ISO8601
+      #   cardToken: string (created by method card_store)
+      #   cvv: number (Security Code)
+      #   amount: number (Only integer numbers, with the last two digits representing the cents.
+      #                   For example: 100 is equivalent to R$ 1,00)
+      #   instalments: number (1 to 12)
+      #
+      # Response:
+      # {
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   }
+      # }
+      #
+      # Response Failure
+      # {
+      #   :result=>{
+      #     :success=>false,
+      #     :code=>"150",
+      #     :message=>"A data externa é obrigatória"
+      #   }
+      # }
+      #
+      def self.authorize(*params)
+        # Parametros são recebidos como um array de hash, pego o 1o item do array
+        params = params.first
+
+        # inicializa as variáveis de retorno
+        result ={}
+        transaction_token = ""
+
+        # define o método de envio da requisição
+        method = :post
+
+        # monta a URL de chamada da requisição
+        endpoint=  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:authorize]
+
+        # regulariza o formato da data
+        params[:externalDate] = (params[:externaldate].blank? ? Time.now.iso8601(1) : params[:externaldate])
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = request(method, endpoint, self.login, self.password, params)
+
+        result = response[:result]
+        nsu = response[:nsu] if !response[:nsu].nil?
+        transaction_token = response[:transactionToken] if !response[:transactionToken].nil?
+
+        return result, transaction_token
+      end
+
+      # This method performs a capture (confirmation) in a already authorized transaction.
+      # This is a is synchronous operation.
+      #
+      # Params:
+      #   transactionToken: string (Transaction unique identification generated by our
+      #                             gateway and received in the transaction authorization response)
+      #
+      # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   }
+      def self.capture(transaction_token)
+        # inicializa as variáveis de retorno
+        result ={}
+
+        # define o método de envio da requisição
+        method = :put
+
+        # monta a URL de chamada da requisição
+        endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:confirm].gsub("{transactionToken}", transaction_token)
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = self.request(method, endpoint, self.login, self.password, {})
+
+        result = response[:result]
+
+        return result
+      end
+
+      # This method performs a cancellation in a already authorized transaction.
+      # This is a is synchronous operation.
+      #
+      # Params:
+      #   transactionToken: string (Transaction unique identification generated by our
+      #                             gateway and received in the transaction authorization response)
+      #
+      # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   }
+      def self.cancellation(transaction_token)
+        # inicializa as variáveis de retorno
+        result ={}
+
+        # define o método de envio da requisição
+        method = :put
+
+        # monta a URL de chamada da requisição
+        endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:cancel].gsub("{transactionToken}", transaction_token)
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = self.request(method, endpoint, self.login, self.password, {})
+        result = response[:result]
+
+        return result
+      end
+
+      # This method performs a refund in a captured authorized transaction.
+      # This is a is synchronous operation.
+      #
+      # Params:
+      #   transactionToken: string (Transaction unique identification generated by our
+      #                             gateway and received in the transaction authorization response)#
+      #
+      #
+      # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   }
+      def self.refund(transaction_token)
+        # inicializa as variáveis de retorno
+        result ={}
+
+        # define o método de envio da requisição
+        method = :put
+
+        # monta a URL de chamada da requisição
+        endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:refund].gsub("{transactionToken}", transaction_token)
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        response = request(method, endpoint, self.login, self.password, {})
+
+        result = response[:result]
+
+        return result
+      end
+
+      # This method performs a query by a specific transaction.
+      # This is a is synchronous operation, using method GET
+      #
+      # Params:
+      #   transactionToken: string (Transaction unique identification generated by our
+      #                             gateway and received in the transaction authorization response)#
+      #
+      #
+      # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   }
+      def self.query_transaction(transaction_token)
+        # inicializa as variáveis de retorno
+        result ={}
+
+        # define o método de envio da requisição
+        method = :get
+
+        # monta a URL de chamada da requisição
+        endpoint =  EndPoints.get_env[:url] + EndPoints.get_env[:context] + EndPoints::Operations[:query_by_transaction].gsub("{transactionToken}", transaction_token)
+
+        response = request(method, endpoint, login, password, params)
+
+        result = response[:result]
+
+        return result
+      end
+
+    end
+end