stitches 5.1.0.RC2 → 5.1.0.RC3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74c049e2d66d366adce255f0fd8d41b6eb0e121669225b1fbce4dbd8ccb19b10
-  data.tar.gz: 8d8b6b8d5cc2e57b4e21a5a9097ccd14b462087c82ce6c30cfd2e6b4617c49c5
+  metadata.gz: e2b49b7056175fa55cc2b597754f143cca6e841a3aafe723fab3681fb646f4c2
+  data.tar.gz: 87a15dcf53ad770755faec02eae327a9195c26b834babaef526dedffe4d9568e
 SHA512:
-  metadata.gz: 343c659a9e37f29caadad39b2c0d66496f164efea60e9a499daec8bb156fd5e90801af304d2bc0ac307c00ee4934b400ea4f22db4e7a996b9d7d114751a5a55c
-  data.tar.gz: dfaa3c860b35fbbbd44ba3c99d4ac1a1ce820de42393ddaa9d93cb12fb0062ad03d14cfb2a7f0ab64dfe5fa83ecd72271c30aa222923ba9fc5cecb35501d8311
+  metadata.gz: b076a27646bd5919cdcf1a2c066536888b90e9a851ce9828369891c3198cbdef8f3208ee1d643344b7f592057d72fefd1b855ab0de0705cdcb708a1d91aa1ccc
+  data.tar.gz: e5d3445946a09d9e54f63060edea96fd5fd0b9156622f9f094850d7ae93cca9a7737d5c7d3800e3c722dbe87a69ea3911e332da1fe3d5ee8c680e4f045cca016

data/.circleci/config.yml

@@ -26,6 +26,9 @@ parameters:
     type: string
     default: "8.1.2"
 
+orbs:
+  stitchfix_build: stitchfix/build@dev:master
+
 jobs:
   generate-and-push-docs:
     docker:
@@ -45,29 +48,12 @@ jobs:
             docs:generate:custom ; elif [[ $(bundle exec rake -T docs:generate) ]];
             then echo "Generating docs using rake task docs:generate" ; bundle exec
             rake docs:generate ; else echo "Skipping doc generation" ; exit 0 ; fi '
+      - stitchfix_build/aws_cli_setup_eng
       - run:
           name: Push documentation to Unwritten
           command:
             if [[ $(bundle exec rake -T docs:push) ]]; then bundle exec rake
             docs:push; fi
-  release:
-    docker:
-      - image: cimg/ruby:3.3.7
-        auth:
-          username: "$DOCKERHUB_USERNAME"
-          password: "$DOCKERHUB_PASSWORD"
-    steps:
-      - checkout
-      - run: bundle config stitchfix01.jfrog.io $ARTIFACTORY_USER:$ARTIFACTORY_TOKEN
-      - run: bundle install
-      - run:
-          name: Artifactory login
-          command:
-            mkdir -p ~/.gem && curl -u$ARTIFACTORY_USER:$ARTIFACTORY_TOKEN https://stitchfix01.jfrog.io/stitchfix01/api/gems/eng-gems/api/v1/api_key.yaml
-            > ~/.gem/credentials && chmod 0600 ~/.gem/credentials
-      - run:
-          name: Build/release gem to artifactory
-          command: bundle exec rake push_artifactory
   test:
     parameters:
       ruby-version:
@@ -87,6 +73,7 @@ jobs:
         auth:
           username: "$DOCKERHUB_USERNAME"
           password: "$DOCKERHUB_PASSWORD"
+    resource_class: medium.gen2
     working_directory: "~/stitches"
     environment:
       DATABASE_URL: "postgres://postgres:@localhost:5432/stitches_fake_app_test"
@@ -136,19 +123,10 @@ workflows:
     unless:
       equal: ["schedule", << pipeline.parameters.GHA_Event >>]
     jobs:
-      - release:
-          context: org-global
-          requires:
-            - test
-          filters:
-            tags:
-              only: "/^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:(-|\\.)(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/"
-            branches:
-              ignore: /.*/
       - generate-and-push-docs:
           context: org-global
           requires:
-            - release
+            - test
           filters:
             tags:
               only: "/^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:(-|\\.)(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$/"

data/lib/stitches/calling_service_name.rb

@@ -1,11 +1,9 @@
 module Stitches
   module CallingServiceName
-    HEADER = "X-StitchFix-Calling-Service"
-
     def calling_service_name
       @calling_service_name ||=
-        request.headers[HEADER].presence ||
-        (respond_to?(:api_client, true) && api_client&.name) ||
+        request.headers[Stitches.configuration.calling_service_header].presence ||
+        request.env[Stitches.configuration.env_var_to_hold_api_client]&.name ||
         ""
     end
   end

data/lib/stitches/configuration.rb

@@ -13,6 +13,7 @@ class Stitches::Configuration
     @custom_http_auth_scheme = UnsetString.new("custom_http_auth_scheme")
     @env_var_to_hold_api_client_primary_key = NonNullString.new("env_var_to_hold_api_client_primary_key","STITCHES_API_CLIENT_ID")
     @env_var_to_hold_api_client= NonNullString.new("env_var_to_hold_api_client","STITCHES_API_CLIENT")
+    @calling_service_header = NonNullString.new("calling_service_header", "X-StitchFix-Calling-Service")
     @max_cache_ttl = NonNullInteger.new("max_cache_ttl", 0)
     @max_cache_size = NonNullInteger.new("max_cache_size", 0)
     @disabled_key_leniency_in_seconds = ActiveSupport::Duration.days(3)
@@ -61,6 +62,16 @@ class Stitches::Configuration
     @env_var_to_hold_api_client= NonNullString.new("env_var_to_hold_api_client",new_env_var_to_hold_api_client)
   end
 
+  # The name of the HTTP header used to identify the calling service.
+  # Clients send this header; servers read it via CallingServiceName.
+  def calling_service_header
+    @calling_service_header.to_s
+  end
+
+  def calling_service_header=(new_calling_service_header)
+    @calling_service_header = NonNullString.new("calling_service_header", new_calling_service_header)
+  end
+
   def max_cache_ttl
     @max_cache_ttl.to_i
   end

data/lib/stitches/version.rb

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

data/spec/calling_service_name_spec.rb

@@ -2,15 +2,13 @@ require 'rails_helper'
 
 describe Stitches::CallingServiceName do
   let(:headers) { {} }
-  let(:fake_request) { double("request", headers: headers) }
-  let(:fake_api_client) { nil }
+  let(:env) { {} }
+  let(:fake_request) { double("request", headers: headers, env: env) }
   let(:fake_controller) {
     req = fake_request
-    client = fake_api_client
     Object.new.tap { |c|
       c.extend(described_class)
       c.define_singleton_method(:request) { req }
-      c.define_singleton_method(:api_client) { client }
     }
   }
 
@@ -22,8 +20,8 @@ describe Stitches::CallingServiceName do
         expect(fake_controller.calling_service_name).to eq("kingmob")
       end
 
-      context "and api_client is also present" do
-        let(:fake_api_client) { double("ApiClient", name: "other-service") }
+      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")
@@ -31,63 +29,58 @@ describe Stitches::CallingServiceName do
       end
     end
 
-    context "when header is absent but api_client is present" do
-      let(:fake_api_client) { double("ApiClient", name: "mobile-service") }
+    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 api_client name" do
+      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(:fake_api_client) { double("ApiClient", name: "fallback-service") }
+      let(:env) { {Stitches.configuration.env_var_to_hold_api_client => double(name: "fallback-service")} }
 
-      it "treats blank as absent and falls through to api_client" do
+      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 api_client is present" do
-      it "returns 'unknown'" do
+    context "when neither header nor env var client is present" do
+      it "returns empty string" do
         expect(fake_controller.calling_service_name).to eq("")
       end
     end
 
-    context "when api_client is nil" do
-      let(:fake_api_client) { nil }
+    context "when env var client is nil" do
+      let(:env) { {Stitches.configuration.env_var_to_hold_api_client => nil} }
 
       it "returns empty string" do
         expect(fake_controller.calling_service_name).to eq("")
       end
     end
 
-    context "when api_client method is not defined" do
-      let(:fake_controller) {
-        req = fake_request
-        Object.new.tap { |c|
-          c.extend(described_class)
-          c.define_singleton_method(:request) { req }
-        }
-      }
+  end
 
-      it "returns empty string" do
-        expect(fake_controller.calling_service_name).to eq("")
-      end
+  describe "configurable header" do
+    it "defaults to X-StitchFix-Calling-Service" do
+      expect(Stitches.configuration.calling_service_header).to eq("X-StitchFix-Calling-Service")
+    end
 
-      context "and header is present" do
-        let(:headers) { {"X-StitchFix-Calling-Service" => "fixops"} }
+    context "when configured to a custom header" do
+      let(:headers) { {"X-Custom-Caller" => "my-service"} }
 
-        it "returns the header value" do
-          expect(fake_controller.calling_service_name).to eq("fixops")
-        end
+      before do
+        Stitches.configuration.calling_service_header = "X-Custom-Caller"
       end
-    end
-  end
 
-  describe "::HEADER" do
-    it "is the expected header name" do
-      expect(described_class::HEADER).to eq("X-StitchFix-Calling-Service")
+      after do
+        Stitches.configuration.reset_to_defaults!
+      end
+
+      it "reads from the configured header" do
+        expect(fake_controller.calling_service_name).to eq("my-service")
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stitches
 version: !ruby/object:Gem::Version
-  version: 5.1.0.RC2
+  version: 5.1.0.RC3
 platform: ruby
 authors:
 - Stitch Fix Engineering