Konfigurimi

Këto ngrenë ArgumentError nga rreshti që përmbante vlerën e gabuar, në vend që të shfaqen si një dështim i paqartë në dërgimin tuaj të parë. Mesazhi thotë çfarë ishte gabim dhe çfarë të jepni në vend të saj, dhe nuk e përsërit kurrë një kredencial.

Ndërtojeni klientin një herë dhe ndajeni. Një klient i ri për çdo kërkesë i hedh poshtë lidhjet e hapura pa asnjë përfitim, dhe asnjë pjesë e gjendjes mbi të nuk është e veçantë për thirrësin. Një klient është i ngrirë sapo ndërtohet dhe mund të përdoret pa rrezik nga shumë fije ekzekutimi njëherësh, ndaj një procesi Puma ose Sidekiq i duhet vetëm një, dhe pas një fork-u procesi bir hap lidhjet e veta.

Për rastin që përndryshe do të detyronte një klient për çdo çelës, si një punë në sfond që dërgon në emër të disa hapësirave të punës, jepni api_key: te thirrja. Ai zëvendëson header-in Authorization për atë kërkesë dhe nuk lë asgjë pas te klienti.

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)

Çdo metodë jashtë temp_mail e merr si argument me fjalë kyçe, pranë filtrave të një liste, ndërsa metodat e temp_mail marrin në vend të tij inbox_token:. Kontrollohet para se të dërgohet kërkesa, me të njëjtin rregull që përdor klienti, ndaj një gabim shtypi ngre një ArgumentError për api_key-n e dhënë në këtë thirrje, në vend të një 401 për një kredencial që pastaj duhet ta kërkoni. Një thirrje e riprovuar e ruan çelësin që iu dha.

client.raw është transporti përmes të cilit kalon çdo metodë. client.raw.request thërret një shteg që ende nuk e mbështjell asnjë metodë, duke zbatuar kredencialin, URL-në bazë, afatin e skadimit dhe politikën e riprovimit të klientit, dhe kthen trupin e analizuar ashtu si një metodë.

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

OpenEmail.create_temp_mail ndërton një klient për kutitë e përkohshme që nuk mban çelës API dhe nuk lexon asnjë nga mjedisi. Krijon kuti në mënyrë anonime, dhe çdo lexim dërgon tokenin e kutisë që ktheu create, ose atë më të riun që ktheu extend, qoftë në çdo thirrje si inbox_token:, qoftë një herë si 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

Një aplikacion që një person e lidhi përmes OAuth, si një mjet i rreshtit të komandave ose një agjent, mban një token qasjeje në vend të një çelësi API. Jepeni si access_token:, qoftë vetë tokenin, qoftë çdo gjë që i përgjigjet call dhe e kthen atë, si një lambda ose një Method. Ai thirret një herë për çdo thirrje, dhe riprovat e asaj thirrjeje ripërdorin atë që ktheu, ndaj rinovojeni tokenin brenda tij kur i afrohet skadimi, dhe klienti nuk ka nevojë të rindërtohet kurrë.

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"

Para një ndryshimi të ndjeshëm, si fshirja e një domeni ose ndryshimi i një webhook-u, API-ja i kërkon një tokeni qasjeje kodin e verifikimit që aplikacioni web do t’ia kërkonte personit. Thirrja ngre një OpenEmail::PermissionError, një 403 me step_up_required? true, dhe asgjë nuk ndryshoi. Kërkoni një kod, verifikoni atë që ju jep personi, pastaj bëjeni thirrjen sërish. Një çelësi API nuk i kërkohet kurrë.

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

Kur në RubyGems ka një version më të ri të gem-it, klienti e thotë këtë një herë për proces, në daljen standarde të gabimeve, me një rresht si ℹ openemail 0.0.2 is available, you are on 0.0.1. të ndjekur nga faqja e gem-it. Kontrolli ekzekutohet kur ndërtohet klienti i parë, në një fije ekzekutimi në sfond me afat skadimi prej dy sekondash, vetëm kur dalja standarde është një terminal, dhe një dështim për të arritur RubyGems shpërfillet.

Adapteri i parazgjedhur e gjen proxy-n e tij me URI#find_proxy të vetë Ruby-t, ndaj ndjek të njëjtat rregulla si pjesa tjetër e bibliotekës standarde: https_proxy ose HTTPS_PROXY emërton proxy-n, ndërsa no_proxy ose NO_PROXY rendit hostet që lidhen drejtpërdrejt. Emri i përdoruesit dhe fjalëkalimi në URL-në e proxy-t i dërgohen proxy-t, dhe një server në këtë makinë nuk arrihet kurrë përmes një proxy-je.

adapter: zëvendëson shtresën HTTP. Është çdo gjë që i përgjigjet call(request), përfshirë një lambda, dhe kthen një OpenEmail::HttpResponse me status, headers dhe body. Kërkesa është një OpenEmail::HttpRequest me method, url, headers, body dhe timeout, ndaj një test mund të kontrollojë saktësisht se çfarë do të ishte dërguar.

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

Printimi i një kërkese e tregon header-in e saj Authorization si [redacted], ndaj një log testimi nuk e mban kurrë çelësin.

• —Ktheni një status jashtë 2xx me zarfin e gabimit të API-së si trup, si p.sh. {"error": {"type": "validation_error", "code": "invalid_parameter", "message": "..."}}, për të marrë nënklasën përkatëse të OpenEmail::ApiError.
• —Ngrini Timeout::Error nga call, ose Net::ReadTimeout, që është një i tillë, për të marrë një OpenEmail::NetworkError me timeout? true. Çdo StandardError tjetër, si Errno::ECONNREFUSED, bëhet një NetworkError me timeout? false.
• —NameError, TypeError dhe ArgumentError të ngritura brenda adapterit llogariten si defekte të tij. Ngrihen të pandryshuara dhe nuk riprovohen kurrë.