whatsapp_notifier 0.8.1 → 0.9.1

data/spec/session_ready_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+# WhatsAppNotifier.session_ready? — the one call hosts make before sending, so
+# they stop each writing their own "authenticated == true, rescue to false".
+RSpec.describe "session readiness" do
+  def configure(adapter)
+    WhatsAppNotifier.configure do |config|
+      config.provider = :web_automation
+      config.web_automation_enabled = true
+      config.web_adapter = adapter
+      config.logger = Logger.new(nil)
+      config.warn_on_risky_provider = false
+    end
+  end
+
+  def adapter_returning(status)
+    adapter = double(send_message: { success: true, session: {} }, fetch_qr_code: "qr")
+    allow(adapter).to receive(:connection_status).and_return(status)
+    adapter
+  end
+
+  def adapter_raising(error)
+    adapter = double(send_message: { success: true, session: {} }, fetch_qr_code: "qr")
+    allow(adapter).to receive(:connection_status).and_raise(error)
+    adapter
+  end
+
+  it "is true only when the service reports an authenticated session" do
+    configure(adapter_returning(state: "AUTHENTICATED", authenticated: true))
+
+    expect(WhatsAppNotifier.session_ready?(user_id: 7)).to be(true)
+  end
+
+  it "is false when the session is not authenticated" do
+    configure(adapter_returning(state: "QR_REQUIRED", authenticated: false))
+
+    expect(WhatsAppNotifier.session_ready?(user_id: 7)).to be(false)
+  end
+
+  # Truthy-but-not-true (a "yes" string from a sloppy adapter) must not read
+  # as ready — the check is deliberately exact.
+  it "is false for a truthy non-true authenticated value" do
+    configure(adapter_returning(authenticated: "yes"))
+
+    expect(WhatsAppNotifier.session_ready?(user_id: 7)).to be(false)
+  end
+
+  it "is false when the adapter answers with something that is not a hash" do
+    configure(adapter_returning(nil))
+
+    expect(WhatsAppNotifier.session_ready?(user_id: 7)).to be(false)
+  end
+
+  # An unreachable status endpoint means the service is down, so sends can't
+  # succeed either — not ready, and logged rather than raised.
+  it "is false and logs when the status endpoint is unreachable" do
+    logger = double(warn: true)
+    configure(adapter_raising(Errno::ECONNREFUSED))
+    WhatsAppNotifier.configuration.logger = logger
+
+    expect(WhatsAppNotifier.session_ready?(user_id: 7)).to be(false)
+    expect(logger).to have_received(:warn).with(/session_ready\? failed/)
+  end
+
+  it "survives a nil logger" do
+    configure(adapter_raising(Errno::ECONNREFUSED))
+    WhatsAppNotifier.configuration.logger = nil
+
+    expect(WhatsAppNotifier.session_ready?(user_id: 7)).to be(false)
+  end
+
+  # A ConfigurationError is a boot-time mistake in the HOST. Swallowing it
+  # would quietly park every campaign behind a "session down" backoff.
+  it "does not swallow a configuration error" do
+    configure(adapter_returning(authenticated: true))
+    WhatsAppNotifier.configuration.web_automation_enabled = false
+
+    expect { WhatsAppNotifier.session_ready?(user_id: 7) }
+      .to raise_error(WhatsAppNotifier::ConfigurationError, /disabled/)
+  end
+
+  it "passes the user id through as status metadata" do
+    adapter = adapter_returning(authenticated: true)
+    configure(adapter)
+
+    WhatsAppNotifier.session_ready?(user_id: 42)
+
+    expect(adapter).to have_received(:connection_status).with(metadata: { user_id: 42 })
+  end
+
+  it "accepts a metadata hash instead of user_id" do
+    adapter = adapter_returning(authenticated: true)
+    configure(adapter)
+
+    WhatsAppNotifier.session_ready?(metadata: { user_id: 9, tenant: "x" })
+
+    expect(adapter).to have_received(:connection_status).with(metadata: { user_id: 9, tenant: "x" })
+  end
+
+  it "asks for the default session when neither is given" do
+    adapter = adapter_returning(authenticated: true)
+    configure(adapter)
+
+    WhatsAppNotifier.session_ready?
+
+    expect(adapter).to have_received(:connection_status).with(metadata: {})
+  end
+
+  it "is not implemented by a bare provider" do
+    provider = WhatsAppNotifier::Providers::Base.new(configuration: WhatsAppNotifier.configuration)
+
+    expect { provider.session_ready? }.to raise_error(NotImplementedError)
+  end
+end

data/spec/web_adapter_spec.rb

@@ -104,6 +104,41 @@ RSpec.describe WhatsAppNotifier::WebAdapter do
     end.to raise_error(/service request failed/)
   end
 
+  # The status is what ErrorCode classifies on — re-deriving it from the
+  # message text would be a regex round-trip through our own string.
+  it "carries the HTTP status on the raised service error" do
+    allow(Net::HTTP).to receive(:start)
+      .and_return(http_failure(code: "401", body: JSON.generate({ error: "User not authenticated" })))
+
+    expect { adapter.send_message(payload: { to: "+1", body: "hi" }, session: {}) }
+      .to raise_error(WhatsAppNotifier::ServiceError) { |error|
+        expect(error.status.to_i).to eq(401)
+        # Pre-0.9.0 this was a bare RuntimeError; hosts rescue that class by
+        # name around media fetches and status polls.
+        expect(error).to be_a(RuntimeError)
+        # Wording unchanged from 0.8.x — hosts that fingerprinted it still match.
+        expect(error.message).to eq("service request failed (401): User not authenticated")
+      }
+  end
+
+  # Forward compatibility: a future service can name the failure itself and
+  # the gem stops guessing from text.
+  it "normalizes an error code the service supplied" do
+    response = http_success(body: { "success" => false, "errorCode" => "NUMBER_NOT_REGISTERED", "error" => "boom" })
+    allow(Net::HTTP).to receive(:start).and_return(response)
+
+    result = adapter.send_message(payload: { to: "+1", body: "hi" }, session: {})
+
+    expect(result).to include(success: false, error_code: :not_on_whatsapp, error_message: "boom")
+  end
+
+  it "leaves error_code nil when the service does not send one" do
+    response = http_success(body: { "success" => false, "error" => "boom" })
+    allow(Net::HTTP).to receive(:start).and_return(response)
+
+    expect(adapter.send_message(payload: { to: "+1", body: "hi" }, session: {})[:error_code]).to be_nil
+  end
+
   it "handles empty and invalid response bodies gracefully" do
     empty_body = instance_double(Net::HTTPOK, body: "", code: "200", is_a?: true)
     invalid_body = instance_double(Net::HTTPInternalServerError, body: "raw-error", code: "500", is_a?: false)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whatsapp_notifier
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.1
 platform: ruby
 authors:
 - Kshitiz Sinha
@@ -56,6 +56,7 @@ files:
 - app/controllers/whatsapp_notifier/sessions_controller.rb
 - bin/whatsapp_notifier
 - config/routes.rb
+- docs/CONFIGURATION.md
 - docs/bulk_messaging_policy.md
 - docs/graphify.md
 - docs/rails_setup.md
@@ -72,6 +73,7 @@ files:
 - lib/whatsapp_notifier/configuration.rb
 - lib/whatsapp_notifier/doctor.rb
 - lib/whatsapp_notifier/engine.rb
+- lib/whatsapp_notifier/error_code.rb
 - lib/whatsapp_notifier/errors.rb
 - lib/whatsapp_notifier/jobs/send_message_job.rb
 - lib/whatsapp_notifier/notification.rb
@@ -107,6 +109,7 @@ files:
 - spec/client_spec.rb
 - spec/configuration_spec.rb
 - spec/doctor_spec.rb
+- spec/error_code_spec.rb
 - spec/generators/install_service_generator_spec.rb
 - spec/jobs/send_message_job_spec.rb
 - spec/notification_spec.rb
@@ -116,6 +119,7 @@ files:
 - spec/result_spec.rb
 - spec/session/qr_service_spec.rb
 - spec/session/store_spec.rb
+- spec/session_ready_spec.rb
 - spec/spec_helper.rb
 - spec/web_adapter_spec.rb
 - spec/whatsapp_notifier_spec.rb