perata-sdk 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64384c4af37e5af51b1adea727b0475da68c843b5c25aedb6392bd3b3cd4bc8a
-  data.tar.gz: b87c39face8ac30151097de8cc07b5be89787420501ea236afc5f4d875f77348
+  metadata.gz: 4ce69fcabc384e43ef9a829c444ced516fb44a64d82daf72fd4d8b7b9ad6dab9
+  data.tar.gz: 43e9821c4ad1cd264bfe59fb8b3fdafabf6d44d31755d067e1e626d21fba753a
 SHA512:
-  metadata.gz: 2cc402f3ac1361b6eaa815bc97615c7d0754486b677fe930623e83a5c7b73f454dd348b6b9f3a942ff235d42e84512580f6ad29fd9af31757cace6f1094fb62c
-  data.tar.gz: 497bec18e6a4a0b4d1f2fd1a7aeccb289877a2cd638d8a8297008d07fd86b0d87b276a3e193532a8160a4f774418dd4da51fd4ce497c58ea554673ef04af6385
+  metadata.gz: 74f8e47737ccb716ff1c9d18354c97eb7260f016ade4b5c4ee4d5b3caa4ba4b676f943c1cf60d089f33eb76f63b5f724983edacc1179021e4cc2b2031adea0c2
+  data.tar.gz: f3e2c307da8270f8db0c41d28b1d4b78bd283e65a83c63d6e6d789c466c65be78976f7c1ce080be492f01e9fd189c1cfefee3c08f3daae08d3caf2507f773f92

data/README.md

@@ -22,19 +22,27 @@ end
 
 | Serviço | Métodos |
 |---|---|
-| `perata.checkouts` | `create` |
-| `perata.customers` | `create`, `get`, `list`, `list_iter` |
-| `perata.orders` | `list`, `list_iter` |
+| `perata.benefits` | `create`, `delete`, `get`, `list`, `list_iter`, `list_grants`, `list_grants_iter`, `update` |
+| `perata.checkout_links` | `create`, `delete`, `get`, `list`, `list_iter`, `update` |
+| `perata.checkouts` | `create`, `get`, `update` |
+| `perata.customer_sessions` | `create` |
+| `perata.customers` | `create`, `delete`, `get`, `get_external`, `get_state`, `list`, `list_iter`, `update`, `update_external` |
+| `perata.discounts` | `create`, `delete`, `get`, `list`, `list_iter`, `update` |
+| `perata.disputes` | `get`, `list`, `list_iter` |
+| `perata.events` | `list`, `list_iter` |
+| `perata.meters` | `get`, `list`, `list_iter` |
+| `perata.orders` | `get`, `get_invoice`, `get_receipt`, `list`, `list_iter` |
 | `perata.payment_methods` | `detach`, `list`, `list_iter` |
 | `perata.payments` | `get`, `list`, `list_iter` |
 | `perata.prices` | `create`, `list`, `list_iter` |
-| `perata.products` | `create`, `get`, `list`, `list_iter` |
-| `perata.refunds` | `create` |
-| `perata.subscriptions` | `cancel`, `get`, `list`, `list_iter` |
+| `perata.products` | `archive`, `create`, `get`, `list`, `list_iter`, `update` |
+| `perata.refunds` | `create`, `list`, `list_iter` |
+| `perata.subscriptions` | `cancel`, `get`, `list`, `list_iter`, `update` |
+| `perata.webhooks` | `create_endpoint`, `delete_endpoint`, `get_endpoint`, `list_deliveries`, `list_deliveries_iter`, `list_endpoints`, `list_endpoints_iter`, `update_endpoint` |
 
 Os modelos são objetos imutáveis com leitores em snake_case (`payment.amount_cents`). O corpo de uma escrita é a classe de parâmetros do método (`Perata::ProductsCreateParams.new(name: "Curso")`) ou um `Hash` com os mesmos nomes; um campo opcional não informado fica fora do JSON. Os métodos `_iter` devolvem um `Enumerator` que percorre todas as páginas a partir de `page:` (ou recebem um bloco).
 
-As escritas aceitam `idempotency_key:`, e todas aceitam `api_key:` para usar a chave de outra organização numa chamada. `Perata::Client.new` aceita `base_url:`, `timeout:` (30 segundos) e `transport:`.
+As escritas aceitam `idempotency_key:`, e todas aceitam `api_key:` para usar a chave de outra organização numa chamada. `Perata::Client.new` aceita `base_url:`, `timeout:` (30 segundos) e `transport:`. Um POST sem chave de idempotência é enviado com uma `Idempotency-Key` própria (UUID v4 aleatório, uma por chamada); passe a sua para poder repetir a mesma operação com segurança.
 
 ## Erros
 
@@ -44,8 +52,15 @@ Uma recusa da API levanta `Perata::Error`, com `status`, `code` (`invalid_reques
 
 ```ruby
 event = Perata.verify_webhook(ENV.fetch("PERATA_WEBHOOK_SECRET"), request.headers, request.raw_post)
+case event
+when Perata::OrderWebhookEvent then puts event.type, event.data.id, event.data.installments
+when Perata::DisputeWebhookEvent then puts event.data.provider_dispute_id
+when Perata::UnknownWebhookEvent then nil # um tipo que esta versão ainda não conhece: event.data é o JSON
+end
 ```
 
 A assinatura é a do Standard Webhooks (`webhook-id`, `webhook-timestamp`, `webhook-signature`), com tolerância de 5 minutos. Passe o corpo cru, antes de interpretar; os cabeçalhos podem vir num `Hash` ou no env do Rack. Uma assinatura que não confere levanta `Perata::WebhookVerificationError`.
 
-Versão do SDK: 0.1.1 · contrato da API: 0.1.0
+O evento é tipado: um tipo para cada dado que o webhook carrega (`OrderWebhookEvent` traz um `Order`, `DisputeWebhookEvent` a disputa, `IdentifiersWebhookEvent` os identificadores…), e o `type` diz o que aconteceu; um tipo que esta versão do SDK ainda não conhece chega como `UnknownWebhookEvent`, com os dados como vieram. Durante a rotação do segredo o cabeçalho traz mais de uma assinatura, e basta uma conferir. `Perata.verify_webhook_signature` só confere a assinatura.
+
+Versão do SDK: 0.3.0 · contrato da API: 0.1.0

data/lib/perata/client.rb

@@ -2,8 +2,10 @@
 
 # Code generated by sdk/generator. DO NOT EDIT.
 
+require "ipaddr"
 require "json"
 require "net/http"
+require "securerandom"
 require "uri"
 
 module Perata
@@ -30,10 +32,24 @@ module Perata
   #   product = perata.products.create({ name: "Curso" })
   #   perata.products.list_iter { |product| puts product.name }
   class Client
+    # @return [BenefitsService]
+    attr_reader :benefits
+    # @return [CheckoutLinksService]
+    attr_reader :checkout_links
     # @return [CheckoutsService]
     attr_reader :checkouts
+    # @return [CustomerSessionsService]
+    attr_reader :customer_sessions
     # @return [CustomersService]
     attr_reader :customers
+    # @return [DiscountsService]
+    attr_reader :discounts
+    # @return [DisputesService]
+    attr_reader :disputes
+    # @return [EventsService]
+    attr_reader :events
+    # @return [MetersService]
+    attr_reader :meters
     # @return [OrdersService]
     attr_reader :orders
     # @return [PaymentMethodsService]
@@ -48,14 +64,26 @@ module Perata
     attr_reader :refunds
     # @return [SubscriptionsService]
     attr_reader :subscriptions
+    # @return [WebhooksService]
+    attr_reader :webhooks
 
+    # The base URL must be https; http is accepted only for localhost,
+    # 127.0.0.0/8 and ::1, and any other raises ArgumentError.
     def initialize(api_key, base_url: DEFAULT_BASE_URL, timeout: 30, transport: NetHTTPTransport.new)
       @api_key = api_key
       @base_url = base_url.chomp("/")
+      check_base_url!(@base_url)
       @timeout = timeout
       @transport = transport
+      @benefits = BenefitsService.new(self)
+      @checkout_links = CheckoutLinksService.new(self)
       @checkouts = CheckoutsService.new(self)
+      @customer_sessions = CustomerSessionsService.new(self)
       @customers = CustomersService.new(self)
+      @discounts = DiscountsService.new(self)
+      @disputes = DisputesService.new(self)
+      @events = EventsService.new(self)
+      @meters = MetersService.new(self)
       @orders = OrdersService.new(self)
       @payment_methods = PaymentMethodsService.new(self)
       @payments = PaymentsService.new(self)
@@ -63,6 +91,7 @@ module Perata
       @products = ProductsService.new(self)
       @refunds = RefundsService.new(self)
       @subscriptions = SubscriptionsService.new(self)
+      @webhooks = WebhooksService.new(self)
     end
 
     # Calls the API and answers what it wrapped in +data+; a refusal raises
@@ -81,11 +110,35 @@ module Perata
         data = JSON.generate(body)
         headers["Content-Type"] = "application/json"
       end
+      # A POST is sent with a key of its own, one a call, unless the caller gave one.
+      idempotency_key = SecureRandom.uuid if (idempotency_key.nil? || idempotency_key.empty?) && method == "POST"
       headers["Idempotency-Key"] = idempotency_key if idempotency_key && !idempotency_key.empty?
       status, response_headers, raw = @transport.call(method, url, headers, data, @timeout)
       raise Error.from_response(status, response_headers, raw) if status >= 300
 
+      return nil if status == 204
+
       JSON.parse(raw).fetch("data")
     end
+
+    private
+
+    def check_base_url!(base_url)
+      uri = begin
+        URI.parse(base_url)
+      rescue URI::InvalidURIError
+        nil
+      end
+      scheme = uri&.scheme.to_s.downcase
+      host = uri&.hostname.to_s.downcase
+      loopback = host == "localhost" || begin
+        IPAddr.new(host).loopback?
+      rescue IPAddr::Error
+        false
+      end
+      return if scheme == "https" || (scheme == "http" && loopback)
+
+      raise ArgumentError, "perata: the base URL must be https (http is accepted only for localhost, 127.0.0.0/8 and ::1), so the API key is never sent in clear text"
+    end
   end
 end