mp_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41b57c5bd90138e2152481283d9d873c550e4e019cf904d7ea4eb9332535cab6
-  data.tar.gz: 9d48cc465911ca89738e30116bc7634b3430d4fc96b5404d5d812fb8a0cd0751
+  metadata.gz: c7b356595131871a92d83ed3c6b65dadc8e291b02c1a1ad4b53db37b60496ca7
+  data.tar.gz: 3a46534f5c479ccf7030b241923ef61d70c8d2348083df66b1f69b690fe47064
 SHA512:
-  metadata.gz: 48911409a2221b723a972067988d02ebc7db00128f3863c445ef3ec171dd3f38812b25bf50f44a69e6b53ea57c93277df4d6e1326bd4f2fc9ef18cb0459eea1a
-  data.tar.gz: c75af862f424527d5034f4feeca1a6526339e80864fcf2fa340e275c82c1478594f78ef284eba99cb4be804fc6582e2c2c717da2af1f0d57232b1f979833c26c
+  metadata.gz: e4730a189dc028ff8fb7ec793a579ab0c01ec8e3b2d3be7c930044d3c2a116783b2c8106d8376ed2eef8197f8febe1bca66f82d603d5cf206e0154c8406980ab
+  data.tar.gz: 0736ee512a1748cd78e44367b1fc349accaf3fe40e8d9dd1a8582f694b75553291c348ee3703d34c614d9b48b0f85fb02f168769d09316ad6c108cc63a7f325c

data/README.md

@@ -1,35 +1,19 @@
-# MercadoPagoApi
-
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mercado_pago_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+# MpApi
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Add solidus_bling to your Gemfile:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+gem 'mp_api'
+```
 
-## Contributing
+Bundle your dependencies and run the installation generator:
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mercado_pago_api.
+```shell
+bin/rails generate mp_api:install
+```
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+Copyright (c) 2023 CaioGarcia1, released under the New BSD License.

data/lib/mp_api/client.rb

@@ -1,7 +1,7 @@
 module MpApi
   class Client < Ac::Base
     BASE_URL = "https://api.mercadopago.com/v1/"
-    MAX_RETRIES = 2
+    MAX_RETRIES = 1
     attr_reader :access_token
     def initialize(access_token=MpApi.configuration.access_token)
       @headers = {
@@ -12,48 +12,30 @@ module MpApi
     end
 
     def create_payment(body)
-      response = post("/payments", body: body, headers: @headers) do |response|
-        p response.json unless response.success?
-        ![500, 429].include?(response.code) || response['id']
-      end
-      raise RequestError.new(response.json['message']) if ![200,201].include?(response.code)
-      response.json
+      post("/payments", body: body, headers: @headers) { |response| validate_response(response, 'id')}
     end
 
     def get_payment(payment_id)
-      response = get("/payments/#{payment_id}") do |response|
-        p response.json unless response.success?
-        ![500, 429].include?(response.code) || response['id']
-      end
-      raise RequestError.new(response.json['message']) if ![200,201].include?(response.code)
-      response.json
+      get("/payments/#{payment_id}") { |response| validate_response(response, 'id')}
     end
 
     def create_token(card_token_data)
-      response = post("/card_tokens", body: card_token_data, headers: @headers) do |response|
-        p response.json unless response.success?
-        ![500, 429].include?(response.code) || response['id']
-      end
-      raise RequestError.new(response.json['message']) if ![200,201].include?(response.code)
-      response.json
+      post("/card_tokens", body: card_token_data, headers: @headers) { |response| validate_response(response, 'id')}
     end
     
     def search_payment_methods(query)
-      response = get("/payment_methods/search", params: query) do |response|
-        p response.json unless response.success?
-        ![500, 429].include?(response.code) || response.json['results'][0]
-      end
-      raise RequestError.new(response.json['message']) if ![200,201].include?(response.code)
-      response.json
+      get("/payment_methods/search", params: query) { |response| validate_response(response, ['results', 0])}
     end
 
     def get_payment_methods
-      response = get("/payment_methods") do |response|
-        p response.json unless response.success?
-        ![500, 429].include?(response.code) || response['id']
-      end
-      raise RequestError.new(response.json['message']) if ![200,201].include?(response.code)
-      response.json
+      get("/payment_methods") { |response| validate_response(response, 'id')}
+    end
+
+    private
+
+    def validate_response(response, required_response_key)
+      puts response.json unless response.success?
+      ![500, 429].include?(response.code) || response.json.dig(*required_response_key)
     end
 
   end

data/lib/mp_api/payment.rb

@@ -1,17 +1,8 @@
 module MpApi
   class Payment
-    
-    def self.find_by_id(payment_id)
-      begin
-        response = Client.new.get_payment(payment_id)
-      rescue RuntimeError => e
-        e.message == 'Too many retries' ? raise(TooManyRequestsError) : raise(e)
-      end
-      new(**build_hash(response))
-    end
 
-    attr_reader :status_detail, :three_ds_info_creq, :three_ds_info_external_resource_url, :three_d_secure_mode, :id, :description, :date_approved, :date_created, :money_release_date, :payer_email, :payer_identification_type, :payer_identification_number, :payment_method, :payment_type, :qr_code, :qr_code_base_64, :transaction_id, :ticket_url, :status, :amount, :token, :issuer_id, :installments, :statement_descriptor, :items
-    def initialize(status_detail:nil, three_ds_info_creq:nil, three_ds_info_external_resource_url:nil, three_d_secure_mode:nil, id:nil, description:nil, date_approved:nil, date_created:nil, money_release_date:nil, payer_email:, payer_identification_type:, payer_identification_number:, payment_method:, payment_type:nil, qr_code:nil, qr_code_base_64:nil, transaction_id:nil, ticket_url:nil, status:nil, amount:, token:nil, issuer_id:nil, installments:nil, items:nil, statement_descriptor:nil)
+    attr_reader :status_detail, :three_ds_info_creq, :three_ds_info_external_resource_url, :three_d_secure_mode, :id, :description, :date_approved, :date_created, :money_release_date, :payer_email, :payer_identification_type, :payer_identification_number, :payment_method, :payment_type, :qr_code, :qr_code_base_64, :transaction_id, :ticket_url, :status, :amount, :token, :issuer_id, :installments, :statement_descriptor, :items, :errors
+    def initialize(status_detail:nil, three_ds_info_creq:nil, three_ds_info_external_resource_url:nil, three_d_secure_mode:nil, id:nil, description:nil, date_approved:nil, date_created:nil, money_release_date:nil, payer_email:, payer_identification_type:, payer_identification_number:, payment_method:, payment_type:nil, qr_code:nil, qr_code_base_64:nil, transaction_id:nil, ticket_url:nil, status:nil, amount:, token:nil, issuer_id:nil, installments:nil, items:nil, statement_descriptor:nil, errors:nil)
       @id = id
       @description = description
       @date_approved = date_approved
@@ -37,14 +28,7 @@ module MpApi
       @status_detail = status_detail
       @statement_descriptor = statement_descriptor
       @items = items
-      # Array example:
-      # {
-      #   id: "100002",
-      #   title: "Retrovisor Jeep",
-      #   picture_url: "https://http2.mlstatic.com/D_NQ_NP_2X_754724-MLB73109764910_122023-F.webp",
-      #   quantity: 4,
-      #   unit_price: 3
-      # }
+      @errors = errors
     end
 
     def build_json
@@ -80,12 +64,13 @@ module MpApi
     end
     
     def create
-      begin
-        response = Client.new.create_payment(JSON.dump(build_json))
-      rescue RuntimeError => e
-        e.message == 'Too many retries' ? raise(TooManyRequestsError) : raise(e)
-      end
-      self.class.new(**self.class.build_hash(response))
+      response = Client.new.create_payment(JSON.dump(build_json))
+      self.class.new(**self.class.build_hash(response.json))
+    end
+        
+    def self.find_by_id(payment_id)
+      response = Client.new.get_payment(payment_id)
+      new(**build_hash(response.json))
     end
 
     def self.build_hash json_response
@@ -108,9 +93,9 @@ module MpApi
         ticket_url: json_response.dig('point_of_interaction', 'transaction_data', 'ticket_url'),
         status: json_response.dig('status'),
         status_detail: json_response.dig('status_detail'),
-        amount: json_response.dig('transaction_amount')
+        amount: json_response.dig('transaction_amount'),
+        errors: PaymentError.new(json_response: json_response).errors
       }
     end
-
   end
 end

data/lib/mp_api/payment_error.rb

@@ -0,0 +1,107 @@
+module MpApi
+  class PaymentError
+    
+    attr_reader :json_response
+    def initialize(json_response:)
+      @json_response = json_response
+    end
+
+    def errors
+      return nil unless json_response['error']
+      json_response['cause'].map {|cause| message_by_error_code(cause['code']) || cause['description']}
+    end
+    
+    private
+    def message_by_error_code(code)
+      {
+        1 => "Erro nos parâmetros.",
+        3 => "O token deve ser de teste.",
+        5 => "É necessário fornecer seu access_token para prosseguir.",
+        23 => "Os seguintes parâmetros devem ter uma data válida e no formato (aaaa-MM-dd'T'HH:mm:ssz) date_of_expiration.",
+        1000 => "Número de linhas excedeu os limites.",
+        1001 => "O formato da data deve ser aaaa-MM-dd'T'HH:mm:ss.SSSZ.",
+        2001 => "Já foi enviada a mesma solicitação no último minuto.",
+        2002 => "Cliente não encontrado.",
+        2004 => "Falha ao enviar POST para a API de Transações do Gateway.",
+        2006 => "Token do cartão não encontrado.",
+        2007 => "Falha na conexão com a API de Token do Cartão.",
+        2009 => "O emissor do token do cartão não pode ser nulo.",
+        2011 => "Id do método de pagamento inválido.",
+        2034 => "Erro estranho do mercado pago de usuarios envolvidos, normalmente causado pelo email do pagador.",
+        2060 => "O cliente não pode ser igual ao coletor.",
+        2062 => "Token do cartão inválido.",
+        2067 => "Número de identificação do usuário inválido.",
+        2072 => "Valor inválido para transaction_amount.",
+        2077 => "Captura diferida não suportada.",
+        2123 => "Operadores inválidos envolvidos.",
+        2131 => "Não é possível inferir o Método de Pagamento.",
+        3000 => "Você deve fornecer o nome do titular do cartão com seus dados do cartão.",
+        3001 => "Você deve fornecer o id do emissor do cartão com seus dados do cartão.",
+        3003 => "Id do token do cartão inválido.",
+        3004 => "Parâmetro site_id inválido.",
+        3005 => "Ação inválida, o recurso está em um estado que não permite esta operação. Para mais informações, consulte o estado que o recurso possui.",
+        3006 => "Parâmetro id do token do cartão inválido.",
+        3007 => "O parâmetro client_id não pode ser nulo ou vazio.",
+        3008 => "Token do Cartão não encontrado.",
+        3009 => "client_id não autorizado.",
+        3010 => "Cartão não encontrado na lista branca.",
+        3011 => "Método de pagamento não encontrado.",
+        3012 => "Parâmetro comprimento do código de segurança inválido.",
+        3013 => "O parâmetro código de segurança é um campo obrigatório e não pode ser nulo ou vazio.",
+        3014 => "Parâmetro método de pagamento inválido.",
+        3015 => "Parâmetro comprimento do número do cartão inválido.",
+        3016 => "Parâmetro número do cartão inválido.",
+        3017 => "O parâmetro id do número do cartão não pode ser nulo ou vazio.",
+        3018 => "O parâmetro mês de vencimento não pode ser nulo ou vazio.",
+        3019 => "O parâmetro ano de vencimento não pode ser nulo ou vazio.",
+        3020 => "O parâmetro nome do titular do cartão não pode ser nulo ou vazio.",
+        3021 => "O parâmetro número do documento do titular do cartão não pode ser nulo ou vazio.",
+        3022 => "O parâmetro tipo de documento do titular do cartão não pode ser nulo ou vazio.",
+        3023 => "O parâmetro subtipo de documento do titular do cartão não pode ser nulo ou vazio.",
+        3024 => "Ação inválida - reembolso parcial não suportado para esta transação.",
+        3025 => "Código de autenticação inválido.",
+        3026 => "Id do cartão inválido para este id do método de pagamento.",
+        3027 => "Id do tipo de pagamento inválido.",
+        3028 => "Id do método de pagamento inválido.",
+        3029 => "Mês de vencimento do cartão inválido.",
+        3030 => "Ano de vencimento do cartão inválido.",
+        3031 => "Secure_code_id não pode ser nulo.",
+        3032 => "Comprimento inválido do código de segurança 3033 3034 - Validação do número do cartão inválida.",
+        4000 => "Atributo do cartão não pode ser nulo.",
+        4001 => "Atributo do id do método de pagamento não pode ser nulo.",
+        4002 => "Atributo do valor da transação não pode ser nulo.",
+        4003 => "Atributo do valor da transação deve ser numérico.",
+        4004 => "Atributo de parcelas não pode ser nulo.",
+        4005 => "Atributo de parcelas deve ser numérico.",
+        4006 => "Atributo do pagador está malformado.",
+        4007 => "Atributo do site_id não pode ser nulo.",
+        4012 => "Atributo do id do pagador não pode ser nulo.",
+        4013 => "Atributo do tipo de pagador não pode ser nulo.",
+        4015 => "Atributo do id de referência do método de pagamento não pode ser nulo.",
+        4016 => "Atributo do id de referência do método de pagamento deve ser numérico.",
+        4017 => "Atributo do status não pode ser nulo.",
+        4018 => "Atributo do id do pagamento não pode ser nulo.",
+        4019 => "Atributo do id do pagamento deve ser numérico.",
+        4020 => "Atributo notificaction_url deve ser uma URL válida.",
+        4021 => "Atributo notificaction_url deve ter menos de 500 caracteres.",
+        4022 => "Atributo metadata deve ser um JSON válido.",
+        4023 => "Atributo do valor da transação não pode ser nulo.",
+        4024 => "Atributo do valor da transação deve ser numérico.",
+        4025 => "Id do reembolso não pode ser nulo.",
+        4026 => "Valor do cupom inválido.",
+        4027 => "Atributo do id da campanha deve ser numérico.",
+        4028 => "Atributo do valor do cupom deve ser numérico.",
+        4029 => "Tipo de pagador inválido.",
+        4037 => "Valor da transação inválido.",
+        4038 => "A taxa de aplicação não pode ser maior que o valor da transação.",
+        4039 => "A taxa de aplicação não pode ser um valor negativo.",
+        4049 => "Atributo do valor da transação deve ser positivo.",
+        4050 => "O email do pagador deve ser um email válido.",
+        4051 => "O email do pagador deve ter menos de 254 caracteres.",
+        6033 => "Usuário indisponível.",
+        7523 => "Data de vencimento inválida."
+      }[code]
+    end
+
+  end
+end

data/lib/mp_api/payment_method.rb

@@ -1,14 +1,18 @@
 module MpApi
   
   class PaymentMethod
-    
+  
+    attr_reader :payment_method_id, :issuer_id, :installments, :errors
+    def initialize(payment_method_id: , issuer_id: , installments:, errors:nil)
+      @payment_method_id = payment_method_id
+      @issuer_id = issuer_id
+      @installments = installments
+      @errors = errors
+    end
+
     def self.find_by_first_six_digits(first_six_digits, credit: true)
-      begin
-        response = Client.new.search_payment_methods(build_query(first_six_digits))
-      rescue RuntimeError => e
-        e.message == 'Too many retries' ? raise(TooManyRequestsError) : raise(e)
-      end
-      new(**build_hash(response, credit))
+      response = Client.new.search_payment_methods(build_query(first_six_digits))
+      new(**build_hash(response.json, credit))
     end
 
     def self.build_query(first_six_digits)
@@ -21,21 +25,15 @@ module MpApi
 
     def self.build_hash(response, credit)
       payment_type_id = credit ? 'credit_card' : 'debit_card'
-      payment_method = response.dig('results').find {|pm| pm['payment_type_id'] == payment_type_id}
+      payment_method = response.dig('results')&.find {|pm| pm['payment_type_id'] == payment_type_id}
       {
-        payment_method_id: payment_method.dig('id'),
-        issuer_id: payment_method.dig('issuer', 'id'),
-        installments: payment_method.dig('payer_costs')
+        payment_method_id: payment_method&.dig('id'),
+        issuer_id: payment_method&.dig('issuer', 'id'),
+        installments: payment_method&.dig('payer_costs'),
+        errors: response.dig('message')
       }
     end
 
-    attr_reader :payment_method_id, :issuer_id, :installments
-    def initialize(payment_method_id: , issuer_id: , installments:)
-      @payment_method_id = payment_method_id
-      @issuer_id = issuer_id
-      @installments = installments
-    end
-
   end
 
 end

data/lib/mp_api/token.rb

@@ -2,14 +2,15 @@ module MpApi
   
   class Token
     
-    attr_reader :card_number, :expiration_year, :expiration_month, :security_code, :cardholder_name, :id
-    def initialize(card_number:nil, expiration_year:nil, expiration_month:nil, security_code:nil, cardholder_name:nil, id:nil)
+    attr_reader :card_number, :expiration_year, :expiration_month, :security_code, :cardholder_name, :id, :errors
+    def initialize(card_number:, expiration_year:, expiration_month:, security_code:, cardholder_name:, id:nil, errors:nil)
       @card_number = card_number
       @expiration_year = expiration_year
       @expiration_month = expiration_month
       @security_code = security_code
       @cardholder_name = cardholder_name
       @id = id
+      @errors = errors
     end
 
     def build_json
@@ -25,12 +26,8 @@ module MpApi
     end
 
     def create
-      begin
-        response = Client.new.create_token(JSON.dump(build_json))
-        self.class.new(**self.class.build_hash(response))
-      rescue RuntimeError => e
-        e.message == 'Too many retries' ? raise(TooManyRequestsError) : raise(e)
-      end
+      response = Client.new.create_token(JSON.dump(build_json))
+      self.class.new(**self.class.build_hash(response.json))
     end
 
     def self.build_hash(response)
@@ -38,25 +35,12 @@ module MpApi
         id: response['id'],
         expiration_year: response['expiration_year'],
         expiration_month: response['expiration_month'],
-        cardholder_name: response['cardholder']['name']
+        cardholder_name: response.dig('cardholder', 'name'),
+        card_number: response['card_number'],
+        security_code: response['security_code'],
+        errors: response['error']
       }
     end
 
   end
 end
-
-# {"id"=>"78558e7bbb73b8939df27269fb6dcbf5",
-#   "first_six_digits"=>"503143",
-#   "expiration_month"=>11,
-#   "expiration_year"=>2025,
-#   "last_four_digits"=>"6351",
-#   "cardholder"=>{"identification"=>{}, "name"=>"APRO"},
-#   "status"=>"active",
-#   "date_created"=>"2023-11-27T09:42:13.887-04:00",
-#   "date_last_updated"=>"2023-11-27T09:42:13.887-04:00",
-#   "date_due"=>"2023-12-05T09:42:13.887-04:00",
-#   "luhn_validation"=>true,
-#   "live_mode"=>false,
-#   "require_esc"=>false,
-#   "card_number_length"=>16,
-#   "security_code_length"=>3}

data/lib/mp_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MpApi
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/mp_api.rb

@@ -3,17 +3,12 @@
 require "ac"
 require_relative "mp_api/client"
 require_relative "mp_api/payment"
+require_relative "mp_api/payment_error"
 require_relative "mp_api/token"
 require_relative "mp_api/payment_method"
 require_relative "mp_api/version"
 module MpApi
   class Error < StandardError; end
-  
-  class TooManyRequestsError < StandardError
-    def message
-      "Too many requests"
-    end  
-  end
 
   class RequestError < StandardError
     def initialize(message="Request error")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mp_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - caio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-21 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ac
@@ -39,6 +39,7 @@ files:
 - lib/mp_api.rb
 - lib/mp_api/client.rb
 - lib/mp_api/payment.rb
+- lib/mp_api/payment_error.rb
 - lib/mp_api/payment_method.rb
 - lib/mp_api/token.rb
 - lib/mp_api/version.rb