Configuración

Estos casos lanzan ArgumentError desde la línea que contenía el valor incorrecto, en lugar de aparecer como un fallo confuso en tu primer envío. El mensaje indica qué estaba mal y qué pasar en su lugar, y nunca repite una credencial.

Construye el cliente una vez y compártelo. Un cliente nuevo por solicitud desecha sus conexiones abiertas sin ganar nada, y ninguno de sus estados es propio de cada llamante. Un cliente queda congelado una vez construido y se puede usar sin riesgo desde muchos hilos de ejecución a la vez, así que un proceso de Puma o Sidekiq solo necesita uno, y tras un fork el proceso hijo abre sus propias conexiones.

Para el caso que de otro modo obligaría a un cliente por clave, como un trabajo que envía en nombre de varios espacios de trabajo, pasa api_key: en la llamada. Sustituye la cabecera Authorization de esa solicitud y no deja nada en el cliente.

message = {from: "[email protected]", to: "[email protected]", subject: "Your invoice", text: "Attached."}workspace_key = ENV.fetch("OPENEMAIL_API_KEY") client.emails.send(message) client.emails.send(message, api_key: workspace_key) client.threads.list(folder: "inbox", api_key: workspace_key)client.webhooks.list(api_key: workspace_key)

Todos los métodos fuera de temp_mail la aceptan como argumento nombrado, junto a los filtros en una lista, y los métodos de temp_mail aceptan inbox_token: en su lugar. Se comprueba antes de enviar la solicitud, con la misma regla que usa el cliente, así que una errata lanza un ArgumentError sobre la api_key pasada a esta llamada en lugar de un 401 sobre una credencial que luego tienes que ir a buscar. Una llamada reintentada conserva la clave que recibió.

client.raw es el transporte por el que pasa cada método. client.raw.request llama a una ruta que ningún método envuelve todavía, aplicando la credencial, la URL base, el tiempo de espera y la política de reintentos del cliente, y devuelve el cuerpo analizado igual que un método.

ping = client.raw.request("/ping") label = client.raw.request("/labels", method: :post, body: {name: "Invoices"}) p ping[:ok], label[:id]

OpenEmail.create_temp_mail construye un cliente para buzones desechables que no lleva ninguna clave de API ni lee ninguna del entorno. Crea buzones de forma anónima, y cada lectura envía el token de buzón que devolvió create, o el más reciente que devolvió extend, bien por llamada como inbox_token:, bien una sola vez como OpenEmail.create_temp_mail(inbox_token:).

temp_mail = OpenEmail.create_temp_mail inbox = temp_mail.createpage = temp_mail.list_messages(inbox[:id], inbox_token: inbox[:token]) p page.items.size, page.expires_at

Una app que una persona conectó por OAuth, como una herramienta de línea de comandos o un agente, tiene un token de acceso en lugar de una clave de API. Pásalo como access_token:, ya sea el propio token o cualquier objeto que responda a call y lo devuelva, como una lambda o un Method. Se invoca una vez por cada llamada, y los reintentos de esa llamada reutilizan lo que devolvió, así que renueva el token dentro de él cuando esté a punto de caducar y nunca tendrás que reconstruir el cliente.

tokens = {current: "token-from-your-oauth-flow"} oauth_client = OpenEmail::Client.new(access_token: -> { tokens.fetch(:current) }) me = oauth_client.me.get puts me[:clientId], me[:expiresAt] if me[:object] == "oauth_token"

Antes de un cambio delicado, como eliminar un dominio o cambiar un webhook, la API pide a un token de acceso el código de verificación que la app web le pediría a la persona. La llamada lanza un OpenEmail::PermissionError, un 403 cuyo step_up_required? es true, y no se cambió nada. Pide un código, verifica el que te dé la persona y vuelve a hacer la llamada. A una clave de API nunca se le pide.

domain_id = "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" begin  client.domains.delete(domain_id)rescue OpenEmail::ApiError => error  raise unless error.step_up_required?   challenge = client.security.begin_step_up   if challenge[:method] == "email"    puts "Enter the code we emailed to #{challenge[:sentTo]}"  else    puts "Enter the code from your authenticator app, or a backup code"  end   client.security.verify_step_up(code: $stdin.gets.to_s.strip)  client.domains.delete(domain_id)end

Cuando hay una versión más reciente de la gema en RubyGems, el cliente lo dice una vez por proceso, en la salida de error estándar, con una línea como ℹ openemail 0.0.2 is available, you are on 0.0.1. seguida de la página de la gema. La comprobación se ejecuta al construir el primer cliente, en un hilo en segundo plano con un tiempo de espera de dos segundos, solo cuando la salida estándar es una terminal, y si no se puede llegar a RubyGems, se ignora.

El adaptador por defecto encuentra su proxy con el propio URI#find_proxy de Ruby, así que sigue las mismas reglas que el resto de la biblioteca estándar: https_proxy o HTTPS_PROXY nombra el proxy, y no_proxy o NO_PROXY enumera los hosts a los que se va directamente. Un nombre de usuario y una contraseña en la URL del proxy se envían al proxy, y a un servidor de esta máquina nunca se llega a través de uno.

adapter: sustituye la capa HTTP. Es cualquier objeto que responda a call(request), una lambda incluida, y devuelva un OpenEmail::HttpResponse con status, headers y body. La solicitud es un OpenEmail::HttpRequest con method, url, headers, body y timeout, así que una prueba puede comprobar exactamente lo que habría salido.

requests = [] adapter = lambda do |request|  requests << request  OpenEmail::HttpResponse.new(    status: 200,    headers: {"content-type" => "application/json"},    body: JSON.generate({id: "msg_test", status: "sent", replayed: false})  )end test_client = OpenEmail::Client.new(api_key: "oe_test_fake", adapter:, max_retries: 0, disable_update_notice: true) sent = test_client.emails.send(from: "[email protected]", to: "[email protected]", subject: "Hi", text: "Hello") p sent[:status], requests.first.method, requests.first.url, requests.first.headers["Idempotency-Key"]p requests.first

Al imprimir una solicitud, su cabecera Authorization aparece como [redacted], así que un registro de pruebas nunca contiene la clave.

• —Devuelve un status fuera de 2xx con el sobre de error de la API como cuerpo, por ejemplo {"error": {"type": "validation_error", "code": "invalid_parameter", "message": "..."}}, para obtener la subclase de OpenEmail::ApiError correspondiente.
• —Lanza Timeout::Error desde call, o Net::ReadTimeout, que es uno de ellos, para obtener un OpenEmail::NetworkError cuyo timeout? es true. Cualquier otro StandardError, como Errno::ECONNREFUSED, se convierte en un NetworkError cuyo timeout? es false.
• —NameError, TypeError y ArgumentError lanzados dentro del adaptador cuentan como errores de programación suyos. Se lanzan sin cambios y nunca se reintentan.