stitches 5.1.0.RC3 → 5.1.0.RC4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2b49b7056175fa55cc2b597754f143cca6e841a3aafe723fab3681fb646f4c2
-  data.tar.gz: 87a15dcf53ad770755faec02eae327a9195c26b834babaef526dedffe4d9568e
+  metadata.gz: 5e1a4aefc1d0249b7b5c8caf2eb06aa6e0866afef4f1d4564d63efa239ef80ce
+  data.tar.gz: 322ab581e74df9bb933d8a1e23d2dc3973c6e3494ebfac23424f16c25cbf589a
 SHA512:
-  metadata.gz: b076a27646bd5919cdcf1a2c066536888b90e9a851ce9828369891c3198cbdef8f3208ee1d643344b7f592057d72fefd1b855ab0de0705cdcb708a1d91aa1ccc
-  data.tar.gz: e5d3445946a09d9e54f63060edea96fd5fd0b9156622f9f094850d7ae93cca9a7737d5c7d3800e3c722dbe87a69ea3911e332da1fe3d5ee8c680e4f045cca016
+  metadata.gz: 5da26d78de12b20c29f2cff453dae8b1b1712ab3f0bbcd373291082eeee1feae3f22dcfb841c512f6a351243f10894b1c91dbc6c5c58400c182be9c0e96ee93c
+  data.tar.gz: 1a2ef89f2e74dfd9478158dfa747c19989de5f32425363f77ae428058468e57d934e29decae0fb1b1bc39a60b1b18abb97c8c82bfd3dfde73ac0b449dc13c995

data/lib/stitches/calling_service_client.rb

@@ -0,0 +1,15 @@
+module Stitches
+  # Lightweight stand-in for ApiClient when the caller is identified by
+  # the X-StitchFix-Calling-Service header rather than an API key lookup.
+  # Implements the same interface (.name, .id, .key) so existing code
+  # that reads api_client.name continues to work.
+  CallingServiceClient = Struct.new(:name) do
+    def id
+      nil
+    end
+
+    def key
+      nil
+    end
+  end
+end

data/lib/stitches/calling_service_middleware.rb

@@ -0,0 +1,29 @@
+require_relative 'calling_service_client'
+
+module Stitches
+  # Rack middleware that populates the api_client env var from the
+  # X-StitchFix-Calling-Service header when no other auth middleware
+  # has already set it. This allows existing code that reads
+  # api_client.name to work transparently after API keys are disabled.
+  class CallingServiceMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      client_key = Stitches.configuration.env_var_to_hold_api_client
+
+      unless env[client_key]
+        header_name = Stitches.configuration.calling_service_header
+        header_name = CallingServiceName::DEFAULT_CALLING_SERVICE_HEADER unless header_name.present?
+        rack_key = "HTTP_#{header_name.upcase.tr('-', '_')}"
+
+        if (name = env[rack_key]).present?
+          env[client_key] = CallingServiceClient.new(name)
+        end
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/stitches/calling_service_name.rb

@@ -1,10 +1,17 @@
 module Stitches
   module CallingServiceName
+    DEFAULT_CALLING_SERVICE_HEADER = "X-StitchFix-Calling-Service"
+
     def calling_service_name
       @calling_service_name ||=
-        request.headers[Stitches.configuration.calling_service_header].presence ||
-        request.env[Stitches.configuration.env_var_to_hold_api_client]&.name ||
-        ""
+        request.headers[calling_service_header_name].presence || ""
+    end
+
+    private
+
+    def calling_service_header_name
+      configured = Stitches.configuration.calling_service_header
+      configured.present? ? configured : DEFAULT_CALLING_SERVICE_HEADER
     end
   end
 end

data/lib/stitches/railtie.rb

@@ -1,10 +1,12 @@
 require 'stitches/api_key'
 require 'stitches/valid_mime_type'
 require 'stitches/api_client_access_wrapper'
+require 'stitches/calling_service_middleware'
 
 module Stitches
   class Railtie < Rails::Railtie
     config.app_middleware.use Stitches::ApiKey
+    config.app_middleware.use Stitches::CallingServiceMiddleware
     config.app_middleware.use Stitches::ValidMimeType
   end
 end

data/lib/stitches/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stitches
-  VERSION = '5.1.0.RC3'
+  VERSION = '5.1.0.RC4'
 end

data/spec/calling_service_middleware_spec.rb

@@ -0,0 +1,72 @@
+require 'rails_helper'
+
+describe Stitches::CallingServiceMiddleware do
+  let(:app) { ->(env) { [200, env, "OK"] } }
+  let(:middleware) { described_class.new(app) }
+  let(:env) { Rack::MockRequest.env_for("/api/test", method: "POST") }
+
+  let(:client_key) { Stitches.configuration.env_var_to_hold_api_client }
+
+  describe "#call" do
+    context "when the header is present and env var is not set" do
+      before { env["HTTP_X_STITCHFIX_CALLING_SERVICE"] = "kingmob" }
+
+      it "populates the env var with a CallingServiceClient" do
+        _status, result_env, _body = middleware.call(env)
+        client = result_env[client_key]
+
+        expect(client).to be_a(Stitches::CallingServiceClient)
+        expect(client.name).to eq("kingmob")
+        expect(client.id).to be_nil
+        expect(client.key).to be_nil
+      end
+    end
+
+    context "when the env var is already set (API key or JWT auth ran)" do
+      let(:existing_client) { double("ApiClient", name: "existing-client", id: 42) }
+
+      before do
+        env[client_key] = existing_client
+        env["HTTP_X_STITCHFIX_CALLING_SERVICE"] = "some-service"
+      end
+
+      it "does not overwrite the existing value" do
+        _status, result_env, _body = middleware.call(env)
+        expect(result_env[client_key]).to eq(existing_client)
+      end
+    end
+
+    context "when the header is absent and env var is not set" do
+      it "leaves the env var nil" do
+        _status, result_env, _body = middleware.call(env)
+        expect(result_env[client_key]).to be_nil
+      end
+    end
+
+    context "when the header is blank" do
+      before { env["HTTP_X_STITCHFIX_CALLING_SERVICE"] = "" }
+
+      it "leaves the env var nil" do
+        _status, result_env, _body = middleware.call(env)
+        expect(result_env[client_key]).to be_nil
+      end
+    end
+
+    context "with a custom configured header" do
+      before do
+        Stitches.configuration.calling_service_header = "X-Custom-Caller"
+        env["HTTP_X_CUSTOM_CALLER"] = "custom-service"
+      end
+
+      after { Stitches.configuration.reset_to_defaults! }
+
+      it "reads from the configured header" do
+        _status, result_env, _body = middleware.call(env)
+        client = result_env[client_key]
+
+        expect(client).to be_a(Stitches::CallingServiceClient)
+        expect(client.name).to eq("custom-service")
+      end
+    end
+  end
+end

data/spec/calling_service_name_spec.rb

@@ -2,8 +2,7 @@ require 'rails_helper'
 
 describe Stitches::CallingServiceName do
   let(:headers) { {} }
-  let(:env) { {} }
-  let(:fake_request) { double("request", headers: headers, env: env) }
+  let(:fake_request) { double("request", headers: headers) }
   let(:fake_controller) {
     req = fake_request
     Object.new.tap { |c|
@@ -13,53 +12,27 @@ describe Stitches::CallingServiceName do
   }
 
   describe "#calling_service_name" do
-    context "when X-StitchFix-Calling-Service header is present" do
+    context "when the header is present" do
       let(:headers) { {"X-StitchFix-Calling-Service" => "kingmob"} }
 
       it "returns the header value" do
         expect(fake_controller.calling_service_name).to eq("kingmob")
       end
-
-      context "and env var client is also present" do
-        let(:env) { {Stitches.configuration.env_var_to_hold_api_client => double(name: "other-service")} }
-
-        it "prefers the header" do
-          expect(fake_controller.calling_service_name).to eq("kingmob")
-        end
-      end
     end
 
-    context "when header is absent but env var client is present" do
-      let(:env) { {Stitches.configuration.env_var_to_hold_api_client => double(name: "mobile-service")} }
-
-      it "returns the client name from env" do
-        expect(fake_controller.calling_service_name).to eq("mobile-service")
-      end
-    end
-
-    context "when header is blank" do
-      let(:headers) { {"X-StitchFix-Calling-Service" => ""} }
-      let(:env) { {Stitches.configuration.env_var_to_hold_api_client => double(name: "fallback-service")} }
-
-      it "treats blank as absent and falls through to env var client" do
-        expect(fake_controller.calling_service_name).to eq("fallback-service")
-      end
-    end
-
-    context "when neither header nor env var client is present" do
+    context "when the header is absent" do
       it "returns empty string" do
         expect(fake_controller.calling_service_name).to eq("")
       end
     end
 
-    context "when env var client is nil" do
-      let(:env) { {Stitches.configuration.env_var_to_hold_api_client => nil} }
+    context "when the header is blank" do
+      let(:headers) { {"X-StitchFix-Calling-Service" => ""} }
 
       it "returns empty string" do
         expect(fake_controller.calling_service_name).to eq("")
       end
     end
-
   end
 
   describe "configurable header" do
@@ -70,13 +43,8 @@ describe Stitches::CallingServiceName do
     context "when configured to a custom header" do
       let(:headers) { {"X-Custom-Caller" => "my-service"} }
 
-      before do
-        Stitches.configuration.calling_service_header = "X-Custom-Caller"
-      end
-
-      after do
-        Stitches.configuration.reset_to_defaults!
-      end
+      before { Stitches.configuration.calling_service_header = "X-Custom-Caller" }
+      after { Stitches.configuration.reset_to_defaults! }
 
       it "reads from the configured header" do
         expect(fake_controller.calling_service_name).to eq("my-service")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 5.1.0.RC3
+  version: 5.1.0.RC4
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -174,6 +174,8 @@ files:
 - lib/stitches/api_key.rb
 - lib/stitches/api_migration_generator.rb
 - lib/stitches/api_version_constraint.rb
+- lib/stitches/calling_service_client.rb
+- lib/stitches/calling_service_middleware.rb
 - lib/stitches/calling_service_name.rb
 - lib/stitches/configuration.rb
 - lib/stitches/deprecation.rb
@@ -209,6 +211,7 @@ files:
 - owners.json
 - spec/api_key_middleware_spec.rb
 - spec/api_version_constraint_middleware_spec.rb
+- spec/calling_service_middleware_spec.rb
 - spec/calling_service_name_spec.rb
 - spec/configuration_spec.rb
 - spec/deprecation_spec.rb
@@ -306,6 +309,7 @@ summary: You'll be in stitches at how easy it is to create a service at Stitch F
 test_files:
 - spec/api_key_middleware_spec.rb
 - spec/api_version_constraint_middleware_spec.rb
+- spec/calling_service_middleware_spec.rb
 - spec/calling_service_name_spec.rb
 - spec/configuration_spec.rb
 - spec/deprecation_spec.rb