midas_client 0.2.1 → 0.2.13b

data/lib/midas_client/request.rb

@@ -5,16 +5,19 @@ module MidasClient
     include EndPoints
 
     attr_accessor :login, :password, :environment
+    attr_accessor :transaction
+    attr_accessor :subscription
+    attr_accessor :query
 
     def initialize(login=nil, password=nil, environment='DEVELOPMENT', option={})
       @login = login
       @password = password
       @environment = environment
-      login.blank? ? log("POS STATIC INITIALIZED!") : log("POS #{login} INITIALIZED!")
+      login.blank? ? log("POS STATIC INITIALIZED!") : log("POS #{login} INITIALIZED - @environment: #{@environment}")
     end
 
     # Method that's wrap generic response
-    def base_result(success, code, message)
+    def self.base_result(success, code, message)
       {
           result: {
               success: success,
@@ -87,5 +90,17 @@ module MidasClient
       response
     end
 
+    def transaction
+      @transaction  ||= Transaction.new(login, password, environment)
+    end
+
+    def subscription
+      @subscription ||= Subscription.new(login, password, environment)
+    end
+
+    def query
+      @query ||= Query.new(login, password, environment)
+    end
+
   end
 end

data/lib/midas_client/subscription.rb

@@ -62,8 +62,11 @@ module MidasClient
       method = :post
 
       # monta a URL de chamada da requisição
-      endpoint=  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:create]
-
+      if params[:cardToken].blank?
+        endpoint=  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:create_manual]
+      else
+        endpoint=  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:create_recurrent]
+      end
 
       params[:externalDate] = (params[:externalDate].blank? ? Time.now.iso8601(1) : params[:externalDate])
       params[:invoicesCount]= (params[:invoicesCount].blank? ? 12 : params[:invoicesCount])
@@ -81,7 +84,7 @@ module MidasClient
     #
     # Response:
     #   result: {
-    #     success: true/false
+    #     success: true/falseb0FIYhr/xCvGFMuR1Wg059X/0cqwLg==
     #     code: "XXX"
     #     message: "Some message to you"
     #   }
@@ -102,9 +105,11 @@ module MidasClient
     # Params:
     #   subscriptionToken: querystring (Subscription unique identification generated by our
     #                             gateway and received in the subscription's creation response)
-    #   amount: number (Only integer numbers, with the last two digits representing the cents.
+    #   params: {
+    #             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 to receive the result for each invoice charge
+    #             callbackUrl: string - URL to receive the result for each invoice charge
+    #           }
     #
     # Response:
     #   result: {
@@ -123,19 +128,52 @@ module MidasClient
       response = request(method, endpoint, self.login, self.password, params)
 
       # recupera a lista de invoices da assinatura para chamar o método de atualização de cada invoice.
-      result, invoices = subscription_invoices(subscription_token)
+      response_invoices = subscription_invoices(subscription_token)
+      result = response_invoices[:result]
+      invoices = response_invoices[:invoices]
 
       # filtra apenas as invoices em aberto
-      opened_invoices = invoices.select{|s| s[:status] == 'OPEN'}
+      opened_invoices = invoices.select{|s| s[:status] == 'OPEN'} unless invoices.blank?
 
       # percorre cada uma das invoices abertas e chama o método de atualização
       opened_invoices.each do |inv|
         update_invoice(inv[:token], {amount: params[:amount]})
-      end
+      end unless opened_invoices.blank?
       response
     end
 
-    #= This method performs a query by a specific transaction.
+    #= This method renew a subscription increasing the number of invoices associated. Works as a most complete update_subscription operation.
+    # This is a is synchronous operation.
+    #
+    # Params:
+    #   subscriptionToken: URL querystring
+    #   body:
+    #   {
+    #     "invoicesCount":2,
+    #     "amount":200,
+    #     "expirationDate":"2019-01-01"
+    #   }
+    #
+    # Response:
+    #   result: {
+    #     success: true/false
+    #     code: "XXX"
+    #     message: "Some message to you"
+    #   }
+    def renew_subscription(subscription_token, params)
+      # define o método de envio da requisição
+      method = :put
+
+      # monta a URL de chamada da requisição
+      endpoint =  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:renew].gsub('{subscriptionToken}', subscription_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS) para atualizar o valor, numero de invoices e data de expiração inicial das novas invoices de uma assinatura.
+      response = request(method, endpoint, self.login, self.password, params)
+
+      response
+    end
+
+    #= This method performs a query by a specific subscription.
     # This is a is synchronous operation, using method GET
     #
     # Params:
@@ -219,6 +257,139 @@ module MidasClient
       request(method, endpoint, self.login, self.password, {})
     end
 
+    #= This method performs a query by a invoice token and return all transactions associated to it.
+    # This is a is synchronous operation, using method GET
+    #
+    # Params:
+    #   invoice_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"
+    #   },
+    #   "transactions": [
+    #    {
+    #        "externalDate": "2017-10-13T03:00:00.731",
+    #        "transactionType": "RECURRENT",
+    #        "paymentMethod": "CREDIT_CARD",
+    #        "creditCard": {
+    #            "brand": "MASTER",
+    #            "panLastDigits": "1137",
+    #            "expirationMonth": 1,
+    #            "expirationYear": 2022,
+    #            "holderName": "Fulano de Tals",
+    #            "customer": {
+    #                "documentType": "CPF",
+    #                "documentNumber": "24503795710"
+    #            }
+    #        },
+    #        "amount": 22950,
+    #        "instalments": 1,
+    #        "token": "3962f882146ec3f6bf581a883f52004f",
+    #        "status": "ERROR"
+    #    }
+    #   ]
+    # }
+    def invoice_transactions(invoice_token)
+      # define o método de envio da requisição
+      method = :get
+
+      # monta a URL de chamada da requisição
+      endpoint =  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:invoice_transactions].gsub('{invoiceToken}', invoice_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      request(method, endpoint, self.login, self.password, {})
+    end
+
+    #= This method associate a transactionToken to an invoice, which changes the invoice status
+    # This is a is synchronous operation, using method PUT
+    #
+    # Params:
+    #   invoice_token: string (Transaction unique identification generated by our
+    #                             gateway and received in the subscription's create response)#
+    #
+    #   transaction_token: string Identification of the token from the transaction that will
+    #                             be associated to the invoice
+    #
+    # Response:
+    #
+    # {
+    #   :result=>{
+    #     :success=>true,
+    #     :code=>"000",
+    #     :message=>"Sucesso"
+    # }
+    def invoice_payment(invoice_token, transaction_token)
+      # define o método de envio da requisição
+      method = :put
+
+      # monta a URL de chamada da requisição
+      endpoint =  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:invoice_payment].gsub('{invoiceToken}', invoice_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      request(method, endpoint, self.login, self.password, {transactionToken: transaction_token})
+    end
+
+    #= This method set an invoice as PAID, which changes the invoice status
+    # This is a is synchronous operation, using method PUT
+    #
+    # Params:
+    #   payment_date: string (format YYYY-MM-DD, ex: 2018-05-28)
+    #
+    #   payment_voucher: string Identification of the external payment that will
+    #                             be associated to the invoice
+    #
+    # Response:
+    #
+    # {
+    #   :result=>{
+    #     :success=>true,
+    #     :code=>"000",
+    #     :message=>"Sucesso"
+    # }
+    def invoice_external_payment(invoice_token, payment_date, payment_voucher)
+      # define o método de envio da requisição
+      method = :put
+
+      # monta a URL de chamada da requisição
+      endpoint =  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:invoice_external_payment].gsub('{invoiceToken}', invoice_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      request(method, endpoint, self.login, self.password, {paymentDate: payment_date, paymentVoucher: payment_voucher})
+    end
+
+    #= This method cancel an invoice of a subscription
+    # This is a is synchronous operation, using method PUT
+    #
+    # Params:
+    #   invoice_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"
+    # }
+    def invoice_cancel(invoice_token)
+      # define o método de envio da requisição
+      method = :put
+
+      # monta a URL de chamada da requisição
+      endpoint =  get_env[:url] + EndPoints::SUBSCRIPTIONS[:context] + EndPoints::SUBSCRIPTIONS[:invoice_cancel].gsub('{invoiceToken}', invoice_token)
+
+      # faz a chamada a plataforma de pagamento (MIDAS)
+      request(method, endpoint, self.login, self.password, {})
+    end
+
     #= This method updates the credit card information associated to the subscription.
     # This is a is synchronous operation, using method PUT
     #
@@ -253,13 +424,12 @@ module MidasClient
 
     #= This method updates a subscription.
     # This is a is synchronous operation.
-    #
+    # QueryString:
+    #   invoice_token: Invoice unique identification generated by our gateway
     # Params:
-    #   subscriptionToken: querystring (Subscription unique identification generated by our
-    #                             gateway and received in the subscription's creation response)
     #   amount: number (Only integer numbers, with the last two digits representing the cents.
     #                   For example: 100 is equivalent to R$ 1,00)
-    #   expirationDate string deadline date for the invoice. FORMAT: YYY-MM-DD
+    #   expirationDate string deadline date for the invoice. FORMAT: YYYY-MM-DD
     #
     # Response:
     #   result: {

data/lib/midas_client/transaction.rb

@@ -377,5 +377,100 @@ module MidasClient
         request(method, endpoint, login, password, {})
       end
 
+      #= This method performs a query to list all creditcards form a user.
+      # This is a is synchronous operation, using method GET
+      #
+      # Params:
+      #   documentType: string (CPF or CNPJ)
+      #   documentNumber: string
+      #
+      #
+      # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   }
+      def query_user_cards(document_type='CPF', document_number)
+        # define o método de envio da requisição
+        method = :get
+
+        # monta a URL de chamada da requisição
+        endpoint =  get_env[:url] + EndPoints::OPERATIONS[:context] + EndPoints::OPERATIONS[:cards_by_user].gsub('{documentType}', document_type).gsub('{documentNumber}', document_number)
+
+        request(method, endpoint, login, password, {})
+      end
+
+      #= This method creates a billet to be paid
+      #
+      # Params:
+      #   externalId: Unique identifier
+      #   externalDate: Date of operation
+      #   bankNumber: Bank Number associated to the PointOfSale
+      #   payer/name: Payer details
+      #   payer/documentType
+      #   payer/documentNumber
+      #   payer/address
+      #   payer/neighborhood
+      #   payer/zipCode
+      #   payer/city
+      #   payer/state
+      #   expirationDate: Expiration Date
+      #   amount: Value of transaction in cents
+      #   callbackURL
+      #
+      # # Response:
+      # {
+      #    "result": {
+      #        "success": true,
+      #        "code": "000",
+      #        "message": "Sucesso"
+      #    },
+      #    "transactionToken": "83f90dd4569ab44cb46faa0f62b645a4",
+      #    "lineCode": "34191.09008  00001.230721  00989.870001  1  74700000000100",
+      #    "url": "http://api.sandbox.ansertecnologia.net/midas-core/v2/transaction/bankbillet/83f90dd4569ab44cb46faa0f62b645a4"
+      # }
+      def create_billet(*params)
+        # Parametros são recebidos como um array de hash, pego o 1o item do array
+        params = params.first
+
+        # define o método de envio da requisição
+        method = :post
+
+        # monta a URL de chamada da requisição
+        endpoint=  get_env[:url] + EndPoints::OPERATIONS[:context] + EndPoints::OPERATIONS[:create_billet]
+
+        # regulariza o formato da data
+        params[:externalDate] = (params[:externalDate].blank? ? Time.now.iso8601(1) : params[:externalDate])
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        request(method, endpoint, self.login, self.password, params)
+
+      end
+
+      #= This method return the URL of billet to be paid
+      # This is a is synchronous operation.
+      #
+      # Params:
+      #   transactionToken: string (Transaction unique identification generated by our
+      #                             gateway and received in the create billet response)
+      #
+      # Response:
+      #   result: {
+      #     success: true/false
+      #     code: "XXX"
+      #     message: "Some message to you"
+      #   }
+      def print_billet(transaction_token)
+        # define o método de envio da requisição
+        method = :get
+
+        # monta a URL de chamada da requisição
+        endpoint =  get_env[:url] + EndPoints::OPERATIONS[:context] + EndPoints::OPERATIONS[:print_billet].gsub('{transactionToken}', transaction_token)
+
+        # faz a chamada a plataforma de pagamento (MIDAS)
+        request(method, endpoint, self.login, self.password, {})
+
+      end
     end
 end

data/lib/midas_client/util.rb

@@ -19,6 +19,10 @@ module MidasClient
       logger.error "#{text}"
     end
 
+    def sanitized_document_number(number)
+      number.gsub('.', '').gsub('-','') unless number.nil?
+    end
+
     def sanitize_pci(text)
       CreditCardSanitizer.new(replacement_token: '@').sanitize!(text.to_s) || text
     end

data/lib/midas_client/version.rb

@@ -1,3 +1,3 @@
 module MidasClient
-  VERSION = "0.2.1"
+  VERSION = "0.2.13b"
 end

data/lib/midas_client.rb

@@ -24,7 +24,7 @@ module MidasClient
     attr_reader :gem_root
 
     spec = Gem::Specification.find_by_name("midas_client")
-    @gem_root = spec.gem_dir
+    @gem_root = spec.try(:gem_dir)
 
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: midas_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.13b
 platform: ruby
 authors:
 - Carlos Andre Oliveira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,6 @@ files:
 - README.md
 - Rakefile
 - lib/midas_client.rb
-- lib/midas_client/billet.rb
 - lib/midas_client/endpoints.rb
 - lib/midas_client/management.rb
 - lib/midas_client/query.rb
@@ -123,12 +122,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Midas Client REST API - https://ansertecnologia.com

data/lib/midas_client/billet.rb

@@ -1,7 +0,0 @@
-module MidasClient
-
-  class Billet < Request
-
-  end
-
-end